xchat.sgml

The major functionality added in this release includes: - Rootless mode in X11 - Widget Templt

 you have the entry "u" and "you":
 </p>
 <p>
 <itemize>
  <item>u - you
  <item>u'r - your
  <item>u''re - you're
 </itemize></p>
 <sect1>Logging
 <p>If you go into Settings - Setup - Options and enable logging then each
 new session this is opened will be logged. Logs are put into &tilde;/.xchat/xchatlogs
 and have the format of servername,sessionname.xchatlog. For example, some entries
 from my logging directory:
 </p>
 <p>
 <itemize>
  <item>us.elitenet.org,&num;linux.xchatlog
  <item>irc-2.mint.net,&num;gimp.xchatlog
  <item>ircnet.demon.co.uk,&num;linux.xchatlog
 </itemize></p>
 <p>You can also use the No ServerName in Logs option, in which case the filenames
 of the logs do not have the server name prepended, thus:
 </p>
 <p>
 <itemize>
  <item>&num;linux.xchatlog
  <item>&num;gimp.xchatlog
 </itemize></p>
 <p>Note that if you are on two channels with the same name the logs will mix
 </p>
 <sect1>Panel support
 <p>With panel support enabled a new button appears next to the de/link button
 on the tool bar - it has a down arrow on it. This button panelizes the session.
 When you first click this a panel applet will appear. The panel applet is a
 label with "X-Chat" and a series of buttons. The direction of the buttons can
 be set in Settings-&gt;Setup-&gt;Options with the "Layout for a vertical panel"
 option. Note that currently you have to restart XChat to make this option come
 into effect. Each panelized session appears as a button in the panel applet.
 If the "Hide session on panelize" option is ticked the session is hidden when
 panelized. Clicking the button will show the session. The color of the text
 of the button will change as is normal (red or blue), and will set back when
 you focus on the session. Right clicking a panel button displays a list of
 items. At the top are 3 labels with the channel, server and tab state of the
 session. Under them are a series of buttons:
 </p>
 <p>
 <itemize>
  <item>Close - Closes the session
  <item>Remove - Removes the panel button
  <item>Hide - Hides the session
  <item>Show - Shows the session
  <item>De/Link - Toggles the link state of the session
  <item>Move here - Moves the session to the mouse position
  <item>View - Shows the text box of the session at the mouse, when the mouse leaves
 the window the text box moves back to the session window
 </itemize></p>
 <sect1>Print Events
 <p>As of 0.9.7 you can now change XChat's output strings. Open up Settings
 - Edit Event Texts to display the current settings.
 </p>
 <p>At the top of the dialog is a list of all the events and the string that
 is displayed when that event happens. Just below is an edit box for changing
 the text. Then there is a text box that shows what the event will look like.
 Under that is a list of the options that is passed to the currently selected
 event (more on this later).
 </p>
 <p>As an example we'll edit the event text for Join. First select join from
 the list at the top, it should be a first item. If it wasn't already the text
 in the edit box will show the Join event text. At first it looks a little complex
 but it really isn't, it breaks down like this:
 </p>
 <p>
 <itemize>
  <item>&percnt;Cxx is a color - &percnt;C4 sets red and so on, '&percnt;C ' sets
 the default color (notice the space after it, forget the quote marks)
  <item>&percnt;B toggles bold
  <item>&dollar;x includes the option number x, as described in the bottom list
  <item>&dollar;axxx adds a single byte with value xxx
 </itemize></p>
 <p>So delete what is already in the edit box and type this:
 </p>
 <p>
 <verb>&percnt;C4*&percnt;C *&percnt;C4*&percnt;C Hey! I can edit the events text!
 &dollar;1 joined &dollar;2 (host: &dollar;3)
 </verb></p>
 <p>The fist bit is the standard red, white, red stars that XChat uses. After
 that it's pretty clear. In the main XChat window wait for someone to join a
 channel you are on (note we changed the Join event *NOT* the You Joining event,
 so this only works for other people joining) and you will see something like:
 </p>
 <p>
 <verb>*** Hey! I can edit the events text! Adam joined &num;a (host: &tilde;Adam@127.0.0.1)
 </verb></p>
 <p>The Sound file entry allows you to enter the name of a sound file that
 will be played (using the play command setting) each time the selected Event
 is triggered.
 </p>
 <p>The 5 buttons at the bottom do thus:
 </p>
 <p>
 <itemize>
  <item>Ok - closes and saves the dialog
  <item>Test All - Shows all the events in the text box
  <item>Load From - Loads a config file
  <item>Save As - Saves to a config file
  <item>Save - Saves to the default config file (loaded on startup) in &tilde;/.xchat/printevents.conf
 </itemize></p>
 <sect1>Key Bindings
 <p>By selecting Settings - Edit Key Bindings you can edit the key bindings
 XChat uses. The key bindings are sorted by use - so the most recent used are
 at the top. A key binding is:
 </p>
 <p>
 <itemize>
  <item>A modification (Ctrl, Alt and Shift keys)
  <item>A keyname
  <item>An action to perform
  <item>2 arguments to the action
 </itemize></p>
 <p>To add a new key binding hit "Add new". An event with &lt;none&gt; will appear
 at the bottom. When you select it (or any binding) the widgets on the right
 change to reflect that binding. To change the key select the entry labeled
 key *and press the key*, *do not try to type in the name!*. The action to perform
 can be selected from the combo at the bottom and help on that action will appear
 in the text box at the bottom.
 </p>
 <p>Changes in the dialog are always current. When the dialog is closed the
 key bindings information is written to &tilde;/.xchat/keybindings.conf
 </p>
 <sect>Settings
 <sect1>Interface
 <p>
 <itemize>
  <item>No Server List On Startup - When set the server is not shown on program
 startup
  <item>Auto Save URL List - Save the URL list on exit
  <item>Double Click Command - The command that is run when a user in the userlist
 is double clicked. &percnt;s in the option is replaced with the nickname of
 that user before running.
 </itemize></p>
 <sect2>IRC Input/Output
 <p>
 <itemize>
  <item>Nick Name Completion - When set text put in will be scanned for incomplete
 nicknames at the beginning and corrected. Also see tab nickname completion
  <item>Time Stamp All Text - When set a time is printed at the beginning of every
 line
  <item>Tab Nicks - When set nicknames and text are aligned with a tab
  <item>Colored Nicks - When set nicknames are color coded
  <item>Strip mIRC Color - When set all color codes in received text are stripped
  <item>Filter out BEEP's - When set all BEEP codes are stripped
  <item>Text Buffer Size - The number of lines a text box buffers (0 = all lines)
  <item>ZVT Buffer Size - The number of lines a ZVT text box buffers
 </itemize></p>
 <sect2>Window Layout
 <p>
 <itemize>
  <item>Channel Mode Buttons - When set the mode buttons are displayed on the tool
 bar
  <item>User List Buttons - When set the command buttons under the userlist are
 displayed
  <item>New Tabs to Front - When set new tabs are set to be the visible tab
  <item>Channel Tabs - When set new channels are displayed in tabs
  <item>Private Message Tabs - When set private dialogs are displayed in tabs
  <item>Tabs at bottom - When set the tabs are put at the bottom of the notebook
  <item>Use a separate tab/window for server messages - When this is set server
 messages are treated as a channel and are put in their own tab or window
  <item>Disable Paned Userlist - When this is set the userlist cannot be paned
 across to be made bigger and is of fixed size
 </itemize></p>
 <sect2>Mail Window
 <p>
 <itemize>
  <item>Left and Top set the initial position of the XChat window
  <item>Width and Height set the size of the XChat window
 </itemize></p>
 <sect2>Channel Windows &amp; Dialog Windows
 <p>These two sections are the same except on what they effect
 </p>
 <p>
 <itemize>
  <item>Normal Font - The font used for normal text
  <item>Bold Font - The font used for bold text
  <item>Background Picture - An image used in the background of the text box
  <item>Use ZVT - When set a ZVT (Zed Virtual Terminal, no connection to zed) widget
 is used not a GTK text box
  <item>Transparent Background - (only with ZVT) When set the background of the
 ZVT is pseudo-transparent
  <item>Tint Transparency - (only with above) When set the transparent background
 is tinted
 </itemize></p>
 <sect2>Panel
 <p>
 <itemize>
  <item>Hide Session on Panelize - When set the tab/window is hidden when panelized
  <item>Layout For a Vertical Panel - When set the panel buttons are packed top
 to bottom
 </itemize></p>
 <sect1>IRC
 <p>
 <itemize>
  <item>Raw Mode Display - When set modes are shown in raw IRC mode rather than
 descriptive texts
  <item>Beep on Private Messages - When set the internal bell is sounded on a private
 message
  <item>Quit Message - The text sent as a reason for you quitting
  <item>DNS Lookup Program - The name of the program used to lookup IP's
  <item>Auto ReConnect Delay - The number of seconds to wait before reconnecting
 to a server
 </itemize></p>
 <sect2>IP Address
 <p>
 <itemize>
  <item>Autodetect hostname - When set the hostname is auto probed
  <item>Autodetect IP address - When set the local IP is auto probed
  <item>Hostname - If not auto probing this is the hostname
  <item>IP address - If not auto probing this is the IP
  <item>Get my IP from Server - (only if auto probing) Gets the IP address from
 the server
 </itemize></p>
 <sect2>Away
 <p>
 <itemize>
  <item>Show away once - When set away messages are only seen once
  <item>Announce away messages - When set your away message is broadcast
  <item>Away Reason - The default away message given
 </itemize></p>
 <sect2>Highlighting
 <p>
 <itemize>
  <item>Extra Words to Highlight on - Words other than your nickname that will
 trigger a highlight
  <item>Hilighted Nick Color - The color set for highlighted nicks
 </itemize></p>
 <sect2>Logging
 <p>
 <itemize>
  <item>Logging - When set logs are created in &tilde;/.xchat/xchatlogs
  <item>No ServerName in logs - When set the names of the log files do not include
 the servername so &num;somechannel on two different servers are treated as
 the same file
 </itemize></p>
 <sect2>Notification
 <p>
 <itemize>
  <item>Highlight Notifies - When set nicks in the userlist are set to a highlight
 color if they are on your notify list
  <item>Notified User Color - The color used for the above
  <item>Notify Check Interval - The number of seconds between checking the status
 of people on your notify list (0 = do not check)
 </itemize></p>
 <sect1>DCC
 <p>
 <itemize>
  <item>Auto * - Automatically open the said window when a request/offer comes
 in
 </itemize></p>
 <sect2>File Transfer
 <p>
 <itemize>
  <item>DCC Offers Timeout - The number of seconds before a DCC offer is removed
 (0 = disable)
  <item>DCC Stall Timeout - The number of seconds before a stalled connection is
 dropped (0 = disable)
  <item>File permissions - The permissions (in octal) of files created by DCC (0600
 is suggested)
  <item>Directory to save to - The directory in which DCC files are put
  <item>Save file with Nickname - Prepend the nickname of the sender to the name
 of the DCC file
  <item>Fast DCC Send - When set DCC doesn't wait for ACK's before sending the
 next packet
 </itemize></p>
 <sect1>CTCP
 <p>
 <itemize>