]> jfr.im git - irc/hexchat/documentation.git/commitdiff
Update settings.rst
authorTingPing <redacted>
Wed, 8 Jan 2014 13:09:39 +0000 (08:09 -0500)
committerTingPing <redacted>
Wed, 8 Jan 2014 13:09:39 +0000 (08:09 -0500)
settings.rst

index b309928db1af7238470c239b607068ff249dc73b..b18840f0125cf7d8b0c1b65f7c998c3098895ee0 100644 (file)
@@ -132,7 +132,7 @@ List of Settings
 | **away\_track**                    | Toggle color change for away users in userlist.                                                                                                                                                                                                                   |
 +------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 | **completion\_amount**             | How may nicks starting with input there should be before all are shown in text box.                                                                                                                                                                               |
-|                                    |  (E.g. if you have 'k' and completion\_amount is set to 6, and there are 6 more people beginning with 'k' in the userlist, then all of the nicks starting with that are shown in the text box. To always cycle nicks, set to 123456 (or any other high number).   |
+|                                    | (E.g. if you have 'k' and completion\_amount is set to 6, and there are 6 more people beginning with 'k' in the userlist, then all of the nicks starting with that are shown in the text box. To always cycle nicks, set to 123456 (or any other high number).    |
 +------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 | **completion\_auto**               | Toggle automatic nick completion.                                                                                                                                                                                                                                 |
 +------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
@@ -143,9 +143,10 @@ List of Settings
 | **dcc\_auto\_chat**                | Toggle auto accept for DCC chats.                                                                                                                                                                                                                                 |
 +------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 | **dcc\_auto\_recv**                | How to accept DCC transfers.                                                                                                                                                                                                                                      |
-|                                    |  0=Ask for confirmation                                                                                                                                                                                                                                           |
-|                                    |  1=Ask for download folder                                                                                                                                                                                                                                        |
-|                                    |  2=Save without interaction                                                                                                                                                                                                                                       |
+|                                    |                                                                                                                                                                                                                                                                   |
+|                                    | - 0=Ask for confirmation                                                                                                                                                                                                                                          |
+|                                    | - 1=Ask for download folder                                                                                                                                                                                                                                       |
+|                                    | - 2=Save without interaction                                                                                                                                                                                                                                      |
 +------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 | **dcc\_auto\_resume**              | Toggle auto resume of DCC transfers.                                                                                                                                                                                                                              |
 +------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
@@ -170,7 +171,7 @@ List of Settings
 | **dcc\_max\_send\_cps**            | Max file transfer speed for one upload in bytes per second.                                                                                                                                                                                                       |
 +------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 | **dcc\_permissions**               | What permissions to set on received files.                                                                                                                                                                                                                        |
-|                                    |  (It's a CHMOD value in decimal, e.g. to CHMOD a file to 644, which is octal, you need to set dcc\_permissions to 420, which is it's decimal equivalent)                                                                                                          |
+|                                    | (It's a CHMOD value in decimal, e.g. to CHMOD a file to 644, which is octal, you need to set dcc\_permissions to 420, which is it's decimal equivalent)                                                                                                           |
 +------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 | **dcc\_port\_first**               | First DCC port in range (leave ports at 0 for full range).                                                                                                                                                                                                        |
 +------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
@@ -231,10 +232,11 @@ List of Settings
 | **gui\_join\_dialog**              | Toggle join dialog after connect.                                                                                                                                                                                                                                 |
 +------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 | **gui\_lagometer**                 | Toggle types of Lag-O-Meters.                                                                                                                                                                                                                                     |
-|                                    |  0=Off                                                                                                                                                                                                                                                            |
-|                                    |  1=Graph                                                                                                                                                                                                                                                          |
-|                                    |  2=Text                                                                                                                                                                                                                                                           |
-|                                    |  3=Both                                                                                                                                                                                                                                                           |
+|                                    |                                                                                                                                                                                                                                                                   |
+|                                    | - 0=Off                                                                                                                                                                                                                                                           |
+|                                    | - 1=Graph                                                                                                                                                                                                                                                         |
+|                                    | - 2=Text                                                                                                                                                                                                                                                          |
+|                                    | - 3=Both                                                                                                                                                                                                                                                          |
 +------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 | **gui\_lang**                      | Set GUI language. Possible values are from 0 to 50 (Win32 only).                                                                                                                                                                                                  |
 +------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
@@ -265,29 +267,33 @@ List of Settings
 | **gui\_tab\_icons**                | Toggle channel tree icons.                                                                                                                                                                                                                                        |
 +------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 | **gui\_tab\_layout**               | Use treeview or tabs.                                                                                                                                                                                                                                             |
-|                                    |  0=Tabs                                                                                                                                                                                                                                                           |
-|                                    |  2=Treeview                                                                                                                                                                                                                                                       |
+|                                    |                                                                                                                                                                                                                                                                   |
+|                                    | - 0=Tabs                                                                                                                                                                                                                                                          |
+|                                    | - 2=Treeview                                                                                                                                                                                                                                                      |
 +------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 | **gui\_tab\_newtofront**           | When to focus new tabs.                                                                                                                                                                                                                                           |
-|                                    |  0=Never                                                                                                                                                                                                                                                          |
-|                                    |  1=Always                                                                                                                                                                                                                                                         |
-|                                    |  2=Only on requested tabs                                                                                                                                                                                                                                         |
+|                                    |                                                                                                                                                                                                                                                                   |
+|                                    | - 0=Never                                                                                                                                                                                                                                                         |
+|                                    | - 1=Always                                                                                                                                                                                                                                                        |
+|                                    | - 2=Only on requested tabs                                                                                                                                                                                                                                        |
 +------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 | **gui\_tab\_pos**                  | Set position of tabs.                                                                                                                                                                                                                                             |
-|                                    |  1=Left-Upper                                                                                                                                                                                                                                                     |
-|                                    |  2=Left                                                                                                                                                                                                                                                           |
-|                                    |  3=Right-Upper                                                                                                                                                                                                                                                    |
-|                                    |  4=Right                                                                                                                                                                                                                                                          |
-|                                    |  5=Top                                                                                                                                                                                                                                                            |
-|                                    |  6=Bottom                                                                                                                                                                                                                                                         |
-|                                    |  7=Hidden                                                                                                                                                                                                                                                         |
+|                                    |                                                                                                                                                                                                                                                                   |
+|                                    | - 1=Left-Upper                                                                                                                                                                                                                                                    |
+|                                    | - 2=Left                                                                                                                                                                                                                                                          |
+|                                    | - 3=Right-Upper                                                                                                                                                                                                                                                   |
+|                                    | - 4=Right                                                                                                                                                                                                                                                         |
+|                                    | - 5=Top                                                                                                                                                                                                                                                           |
+|                                    | - 6=Bottom                                                                                                                                                                                                                                                        |
+|                                    | - 7=Hidden                                                                                                                                                                                                                                                        |
 +------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 | **gui\_tab\_server**               | Open an extra tab for server messages.                                                                                                                                                                                                                            |
 +------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 | **gui\_tab\_small**                | Set small tabs.                                                                                                                                                                                                                                                   |
-|                                    |  0=Off                                                                                                                                                                                                                                                            |
-|                                    |  1=Small tabs                                                                                                                                                                                                                                                     |
-|                                    |  2=Extra small tabs                                                                                                                                                                                                                                               |
+|                                    |                                                                                                                                                                                                                                                                   |
+|                                    | - 0=Off                                                                                                                                                                                                                                                           |
+|                                    | - 1=Small tabs                                                                                                                                                                                                                                                    |
+|                                    | - 2=Extra small tabs                                                                                                                                                                                                                                              |
 +------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 | **gui\_tab\_sort**                 | Toggle alphabetical sorting of tabs.                                                                                                                                                                                                                              |
 +------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
@@ -296,10 +302,11 @@ List of Settings
 | **gui\_tab\_utils**                | Open utils in tabs instead of windows.                                                                                                                                                                                                                            |
 +------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 | **gui\_throttlemeter**             | Toggle types of throttle meters.                                                                                                                                                                                                                                  |
-|                                    |  0=Off                                                                                                                                                                                                                                                            |
-|                                    |  1=Graph                                                                                                                                                                                                                                                          |
-|                                    |  2=Text                                                                                                                                                                                                                                                           |
-|                                    |  3=Both                                                                                                                                                                                                                                                           |
+|                                    |                                                                                                                                                                                                                                                                   |
+|                                    | - 0=Off                                                                                                                                                                                                                                                           |
+|                                    | - 1=Graph                                                                                                                                                                                                                                                         |
+|                                    | - 2=Text                                                                                                                                                                                                                                                          |
+|                                    | - 3=Both                                                                                                                                                                                                                                                          |
 +------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 | **gui\_topicbar**                  | Toggle topic bar.                                                                                                                                                                                                                                                 |
 +------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
@@ -326,30 +333,33 @@ List of Settings
 | **gui\_ulist\_icons**              | Toggle use of icons instead of text symbols in user list.                                                                                                                                                                                                         |
 +------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 | **gui\_ulist\_pos**                | Set userlist position.                                                                                                                                                                                                                                            |
-|                                    |  1=Left-Upper                                                                                                                                                                                                                                                     |
-|                                    |  2=Left-Lower                                                                                                                                                                                                                                                     |
-|                                    |  3=Right-Upper                                                                                                                                                                                                                                                    |
-|                                    |  4=Right-Lower                                                                                                                                                                                                                                                    |
+|                                    |                                                                                                                                                                                                                                                                   |
+|                                    | - 1=Left-Upper                                                                                                                                                                                                                                                    |
+|                                    | - 2=Left-Lower                                                                                                                                                                                                                                                    |
+|                                    | - 3=Right-Upper                                                                                                                                                                                                                                                   |
+|                                    | - 4=Right-Lower                                                                                                                                                                                                                                                   |
 +------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 | **gui\_ulist\_resizable**          | Toggle resizable userlist.                                                                                                                                                                                                                                        |
 +------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 | **gui\_ulist\_show\_hosts**        | Toggle user's hosts displaying in userlist. (requires irc_who_join)                                                                                                                                                                                               |
 +------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 | **gui\_ulist\_sort**               | How to sort users in the userlist.                                                                                                                                                                                                                                |
-|                                    |  0=A-Z with Ops first                                                                                                                                                                                                                                             |
-|                                    |  1=A-Z                                                                                                                                                                                                                                                            |
-|                                    |  2=A-Z with Ops last                                                                                                                                                                                                                                              |
-|                                    |  3=Z-A                                                                                                                                                                                                                                                            |
-|                                    |  4=Unsorted                                                                                                                                                                                                                                                       |
+|                                    |                                                                                                                                                                                                                                                                   |
+|                                    | - 0=A-Z with Ops first                                                                                                                                                                                                                                            |
+|                                    | - 1=A-Z                                                                                                                                                                                                                                                           |
+|                                    | - 2=A-Z with Ops last                                                                                                                                                                                                                                             |
+|                                    | - 3=Z-A                                                                                                                                                                                                                                                           |
+|                                    | - 4=Unsorted                                                                                                                                                                                                                                                      |
 +------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 | **gui\_ulist\_style**              | Toggle use of text box colors and fonts in userlist.                                                                                                                                                                                                              |
 +------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 | **gui\_url\_mod**                  | How to handle URLs when clicked. (And what to hold.)                                                                                                                                                                                                              |
-|                                    |  0=Left Click Only                                                                                                                                                                                                                                                |
-|                                    |  1=Shift                                                                                                                                                                                                                                                          |
-|                                    |  2=Caps Lock                                                                                                                                                                                                                                                      |
-|                                    |  4=CTRL                                                                                                                                                                                                                                                           |
-|                                    |  8=ALT                                                                                                                                                                                                                                                            |
+|                                    |                                                                                                                                                                                                                                                                   |
+|                                    | - 0=Left Click Only                                                                                                                                                                                                                                               |
+|                                    | - 1=Shift                                                                                                                                                                                                                                                         |
+|                                    | - 2=Caps Lock                                                                                                                                                                                                                                                     |
+|                                    | - 4=CTRL                                                                                                                                                                                                                                                          |
+|                                    | - 8=ALT                                                                                                                                                                                                                                                           |
 +------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 | **gui\_usermenu**                  | Toggle editable usermenu.                                                                                                                                                                                                                                         |
 +------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
@@ -362,8 +372,9 @@ List of Settings
 | **gui\_win\_save**                 | Toggles saving of state on exit.                                                                                                                                                                                                                                  |
 +------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 | **gui\_win\_state**                | Default state of the main window.                                                                                                                                                                                                                                 |
-|                                    |  0=Not Maximized                                                                                                                                                                                                                                                  |
-|                                    |  1=Maximized                                                                                                                                                                                                                                                      |
+|                                    |                                                                                                                                                                                                                                                                   |
+|                                    | - 0=Not Maximized                                                                                                                                                                                                                                                 |
+|                                    | - 1=Maximized                                                                                                                                                                                                                                                     |
 +------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 | **gui\_win\_swap**                 | Swap the middle and left panes (allows side-by-side userlist/tree).                                                                                                                                                                                               |
 +------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
@@ -390,7 +401,7 @@ List of Settings
 | **input\_beep\_priv**              | Toggle beep on private messages.                                                                                                                                                                                                                                  |
 +------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 | **input\_command\_char**           | Character used to execute commands.                                                                                                                                                                                                                               |
-|                                    |  (E.g. if set to '[' then you would use commands like '[me jumps around')                                                                                                                                                                                         |
+|                                    | (E.g. if set to '[' then you would use commands like '[me jumps around')                                                                                                                                                                                          |
 +------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 | **input\_filter\_beep**            | Toggle filtering of beeps sent by others.                                                                                                                                                                                                                         |
 +------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
@@ -413,14 +424,16 @@ List of Settings
 | **irc\_auto\_rejoin**              | Toggle auto rejoining when kicked.                                                                                                                                                                                                                                |
 +------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 | **irc\_ban\_type**                 | The default ban type to use for all bans. (requres irc_who_join)                                                                                                                                                                                                  |
-|                                    |  0=\*!\*\@\*.host                                                                                                                                                                                                                                                 |
-|                                    |  1=\*!\*\@domain                                                                                                                                                                                                                                                  |
-|                                    |  2=\*!\*user\@\*.host                                                                                                                                                                                                                                             |
-|                                    |  3=\*!\*user\@domain                                                                                                                                                                                                                                              |
+|                                    |                                                                                                                                                                                                                                                                   |
+|                                    | - 0=\*!\*\@\*.host                                                                                                                                                                                                                                                |
+|                                    | - 1=\*!\*\@domain                                                                                                                                                                                                                                                 |
+|                                    | - 2=\*!\*user\@\*.host                                                                                                                                                                                                                                            |
+|                                    | - 3=\*!\*user\@domain                                                                                                                                                                                                                                             |
 +------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 | **irc\_conf\_mode**                | Toggle hiding of join, part and quit messages. (`More info <http://toxin.jottit.com/xchat_tips_&_tricks#09>`_)                                                                                                                                                    |
-|                                    |  0=Show join/part/quits                                                                                                                                                                                                                                           |
-|                                    |  1=Hide join/part/quits                                                                                                                                                                                                                                           |
+|                                    |                                                                                                                                                                                                                                                                   |
+|                                    | - 0=Show join/part/quits                                                                                                                                                                                                                                          |
+|                                    | - 1=Hide join/part/quits                                                                                                                                                                                                                                          |
 +------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 | **irc\_extra\_hilight**            | Extra words to highlight on.                                                                                                                                                                                                                                      |
 +------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
@@ -447,9 +460,10 @@ List of Settings
 | **irc\_nick\_hilight**             | What nicks to highlight when they talk.                                                                                                                                                                                                                           |
 +------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 | **irc\_notice\_pos**               | Placement of Notices:                                                                                                                                                                                                                                             |
-|                                    | 1. Automatic                                                                                                                                                                                                                                                      |
-|                                    | 2. Open extra (notices) tab                                                                                                                                                                                                                                       |
-|                                    | 3. Always place in front tab                                                                                                                                                                                                                                      |
+|                                    |                                                                                                                                                                                                                                                                   |
+|                                    | - 0 = Automatic                                                                                                                                                                                                                                                   |
+|                                    | - 1 = Open extra (notices) tab                                                                                                                                                                                                                                    |
+|                                    | - 2 = Always place in front tab                                                                                                                                                                                                                                   |
 +------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 | **irc\_no\_hilight**               | Nicks not to highlight on.                                                                                                                                                                                                                                        |
 +------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
@@ -490,17 +504,19 @@ List of Settings
 | **net\_proxy\_port**               | Port to use for proxy host.                                                                                                                                                                                                                                       |
 +------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 | **net\_proxy\_type**               | Type of proxy to use.                                                                                                                                                                                                                                             |
-|                                    |  0=Disabled                                                                                                                                                                                                                                                       |
-|                                    |  1=Wingate                                                                                                                                                                                                                                                        |
-|                                    |  2=Socks4                                                                                                                                                                                                                                                         |
-|                                    |  3=Socks5                                                                                                                                                                                                                                                         |
-|                                    |  4=HTTP                                                                                                                                                                                                                                                           |
-|                                    |  5=MS Proxy (ISA)                                                                                                                                                                                                                                                 |
+|                                    |                                                                                                                                                                                                                                                                   |
+|                                    | - 0=Disabled                                                                                                                                                                                                                                                      |
+|                                    | - 1=Wingate                                                                                                                                                                                                                                                       |
+|                                    | - 2=Socks4                                                                                                                                                                                                                                                        |
+|                                    | - 3=Socks5                                                                                                                                                                                                                                                        |
+|                                    | - 4=HTTP                                                                                                                                                                                                                                                          |
+|                                    | - 5=MS Proxy (ISA)                                                                                                                                                                                                                                                |
 +------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 | **net\_proxy\_use**                | What to use proxies for (if set).                                                                                                                                                                                                                                 |
-|                                    |  0=All                                                                                                                                                                                                                                                            |
-|                                    |  1=IRC Only                                                                                                                                                                                                                                                       |
-|                                    |  2=DCC Only                                                                                                                                                                                                                                                       |
+|                                    |                                                                                                                                                                                                                                                                   |
+|                                    | - 0=All                                                                                                                                                                                                                                                           |
+|                                    | - 1=IRC Only                                                                                                                                                                                                                                                      |
+|                                    | - 2=DCC Only                                                                                                                                                                                                                                                      |
 +------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 | **net\_proxy\_user**               | Username to use if proxy authentication is turned on.                                                                                                                                                                                                             |
 +------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+