Tha_14/toxic
1
0
Fork 0
mirror of https://github.com/Tha14/toxic.git synced 2024-11-22 19:13:02 +01:00
Code Issues Projects Releases Wiki Activity

Some documentation improvements

Browse Source
This commit is contained in:
jfreegman 2021-12-05 17:03:42 -05:00
parent 8aa57b0539
commit e9a0a30408
No known key found for this signature in database
GPG Key ID: 3627F3144076AE63
6 changed files with 19 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
doc/toxic.1
View File

@ -2,12 +2,12 @@
.\" Title: toxic .\" Title: toxic
.\" Author: [see the "AUTHORS" section] .\" Author: [see the "AUTHORS" section]
.\" Generator: DocBook XSL Stylesheets v1.79.1 <http://docbook.sf.net/> .\" Generator: DocBook XSL Stylesheets v1.79.1 <http://docbook.sf.net/>
.\" Date: 2020-05-04 .\" Date: 2021-05-24
.\" Manual: Toxic Manual .\" Manual: Toxic Manual
.\" Source: toxic __VERSION__ .\" Source: toxic __VERSION__
.\" Language: English .\" Language: English
.\" .\"
.TH "TOXIC" "1" "2020\-05\-04" "toxic __VERSION__" "Toxic Manual" .TH "TOXIC" "1" "2021\-05\-24" "toxic __VERSION__" "Toxic Manual"
.\" ----------------------------------------------------------------- .\" -----------------------------------------------------------------
.\" * Define some portability stuff .\" * Define some portability stuff
.\" ----------------------------------------------------------------- .\" -----------------------------------------------------------------
@ -153,9 +153,9 @@ Configuration example\&.
.sp .sp
\-Unicode characters with a width larger than 1 column may cause strange behaviour\&. \-Unicode characters with a width larger than 1 column may cause strange behaviour\&.
.sp .sp
\-Text occasionally fails to auto\-scroll to the bottom\&.
.sp
\-Screen flickering sometimes occurs on certain terminals\&. \-Screen flickering sometimes occurs on certain terminals\&.
.sp
\-Resizing the terminal window when a game window is open will break things\&.
.SH "AUTHORS" .SH "AUTHORS"
.sp .sp
JFreegman <JFreegman@gmail\&.com> JFreegman <JFreegman@gmail\&.com>

4
doc/toxic.1.asc
View File

@ -89,10 +89,10 @@ BUGS
-Unicode characters with a width larger than 1 column may cause strange -Unicode characters with a width larger than 1 column may cause strange
behaviour. behaviour.
-Text occasionally fails to auto-scroll to the bottom.
-Screen flickering sometimes occurs on certain terminals. -Screen flickering sometimes occurs on certain terminals.
-Resizing the terminal window when a game window is open will break things.
AUTHORS AUTHORS
------- -------
JFreegman <JFreegman@gmail.com> JFreegman <JFreegman@gmail.com>

4
doc/toxic.conf.5
View File

@ -2,12 +2,12 @@
.\" Title: toxic.conf .\" Title: toxic.conf
.\" Author: [see the "AUTHORS" section] .\" Author: [see the "AUTHORS" section]
.\" Generator: DocBook XSL Stylesheets v1.79.1 <http://docbook.sf.net/> .\" Generator: DocBook XSL Stylesheets v1.79.1 <http://docbook.sf.net/>
.\" Date: 2020-12-05 .\" Date: 2021-05-24
.\" Manual: Toxic Manual .\" Manual: Toxic Manual
.\" Source: toxic __VERSION__ .\" Source: toxic __VERSION__
.\" Language: English .\" Language: English
.\" .\"
.TH "TOXIC\&.CONF" "5" "2020\-12\-05" "toxic __VERSION__" "Toxic Manual" .TH "TOXIC\&.CONF" "5" "2021\-05\-24" "toxic __VERSION__" "Toxic Manual"
.\" ----------------------------------------------------------------- .\" -----------------------------------------------------------------
.\" * Define some portability stuff .\" * Define some portability stuff
.\" ----------------------------------------------------------------- .\" -----------------------------------------------------------------

2
src/settings.h
View File

@ -32,7 +32,7 @@
#define PASSWORD_EVAL_MAX 512 #define PASSWORD_EVAL_MAX 512
/* holds user setting values */ /* Holds user setting values defined in the toxic config file. */
struct user_settings { struct user_settings {
int autolog; /* boolean */ int autolog; /* boolean */
int alerts; /* boolean */ int alerts; /* boolean */

3
src/toxic.c
View File

@ -101,6 +101,9 @@ struct Winthread Winthread;
struct cqueue_thread cqueue_thread; struct cqueue_thread cqueue_thread;
struct av_thread av_thread; struct av_thread av_thread;
struct arg_opts arg_opts; struct arg_opts arg_opts;
// This struct is not thread safe. It should only ever be written to from the main thread
// before any other thread that uses it is initialized.
struct user_settings *user_settings = NULL; struct user_settings *user_settings = NULL;
static struct user_password { static struct user_password {

7
src/windows.h
View File

@ -98,6 +98,13 @@ typedef enum {
Uncomment if necessary */ Uncomment if necessary */
/* #define URXVT_FIX */ /* #define URXVT_FIX */
/*
* Used to control access to global variables via a mutex, as well as to handle signals.
* Any file, variable or data structure that is used by the UI/Window thread and any other thread
* must be guarded by `lock`.
*
* There should only ever be one instance of this struct.
*/
struct Winthread { struct Winthread {
pthread_t tid; pthread_t tid;
pthread_mutex_t lock; pthread_mutex_t lock;