diff options
Diffstat (limited to 'share')
| -rw-r--r-- | share/doc/perl.md | 23 | ||||
| -rw-r--r-- | share/doc/plugins.md | 3 | ||||
| -rw-r--r-- | share/doc/python.md | 2 | ||||
| -rw-r--r-- | share/doc/tcl.md | 22 |
4 files changed, 23 insertions, 27 deletions
diff --git a/share/doc/perl.md b/share/doc/perl.md index 683e4683..7a7aa5db 100644 --- a/share/doc/perl.md +++ b/share/doc/perl.md @@ -362,8 +362,16 @@ Returns true on success, false on failure. <td>charset</td> <td>character-set used in the current context</td> <td>CHARSET</td> - </tr> <tr> - <td>event\_text <Event Name></td> <td>text event format string for <Event name><br /> + </tr> +<tr> + <td>configdir</td> <td>HexChat config directory encoded in UTF-8. Examples:<br /> + /home/user/.config/hexchat<br /> + C:\Users\user\Appdata\Roaming\HexChat + </td> + <td></td> +</tr> +<tr> + <td>event_text <Event Name></td> <td>text event format string for <Event name><br /> Example: <div class="example synNormal"><div class='line_number'> <div>1</div> @@ -442,17 +450,6 @@ Returns true on success, false on failure. <td>similar to win_ptr except it will always be a GtkWindow *</td> <td></td> </tr> -<tr> - <td>hexchatdir</td> <td>HexChat config directory encoded in UTF-8<br /> - examples:<br /> - /home/user/.config/hexchat<br /> - C:\Users\user\Appdata\Roaming\HexChat - </td> - <td></td> -</tr><tr> - <td>hexchatdirfs</td> <td>same as hexchatdir except encoded in the locale file system encoding</td> - <td></td> -</tr> </table> This function is used to retrieve certain information about the current diff --git a/share/doc/plugins.md b/share/doc/plugins.md index a46c4177..060f2c65 100644 --- a/share/doc/plugins.md +++ b/share/doc/plugins.md @@ -808,10 +808,9 @@ Changed in 2.6.1. If _servname_ is NULL, it finds the channel (or query) by the * **away:** away reason or NULL if you are not away. * **channel:** current channel name. * **charset:** character-set used in the current context. + * **configdir:** HexChat config directory, e.g.: `/home/user/.config/hexchat`. This string is encoded in UTF-8. * **event\_text <name>:** text event format string for _name_. * **gtkwin\_ptr:** (GtkWindow \*). - * **hexchatdir:** HexChat config directory, e.g.: /home/user/.config/hexchat. This string is encoded in UTF-8, which means you **should** convert it to "locale" encoding before using functions like open() or OpenFile(). For best Unicode support on Linux, convert this string using g\_filename\_from\_utf8 and on Windows convert this string to UTF-16LE (wide) and use OpenFileW() etc. - * **hexchatdirfs:** HexChat config directory, e.g.: /home/user/.config/hexchat. This string is encoded in local file system encoding, making it ideal for direct use with functions like open() or OpenFile(). For real Unicode support on Windows, it's best not to use hexchatdirfs, but hexchatdir instead. * **host:** real hostname of the server you connected to. * **inputbox:** the input-box contents, what the user has typed. * **libdirfs:** library directory. e.g. /usr/lib/hexchat. The same directory used for auto-loading plugins. This string isn't necessarily UTF-8, but local file system encoding. diff --git a/share/doc/python.md b/share/doc/python.md index dc4ff1ec..1020d645 100644 --- a/share/doc/python.md +++ b/share/doc/python.md @@ -157,9 +157,9 @@ are available to be queried: * **away:** Away reason or None if you are not away. * **channel:** Channel name of the current context. * **charset:** Charset in current context. + * **configdir:** HexChat config directory e.g.: "~/.config/hexchat". * **event_name NAME:** Returns text event string for requested event. * **gtkwin_ptr:** Current Gtk Window. - * **hexchatdir:** HexChat config directory e.g.: "~/.config/hexchat". * **host:** Real hostname of the server you connected to. * **inputbox:** Contents of inputbox. * **network:** Current network name or None. diff --git a/share/doc/tcl.md b/share/doc/tcl.md index 506da056..7f3f6db3 100644 --- a/share/doc/tcl.md +++ b/share/doc/tcl.md @@ -95,7 +95,7 @@ before Eggdrop and is broadly considered the industry standard language for auto <tr valign=top> <td align=right><b>Example:</b></td> <td><pre>/tcl puts "Hello, XChat World!" -/tcl hexchatdir</pre></td> +/tcl configdir</pre></td> </tr> @@ -680,6 +680,10 @@ The following fields are currently defined: </td> </tr> <tr> +<td>configdir </td> +<td> HexChat config directory, e.g.: /home/user/.config/hexchat.</td> +</tr> +<tr> <td>host </td> <td> real hostname of the server you connected to. </td> @@ -709,10 +713,6 @@ The following fields are currently defined: <td> HexChat version number. </td> </tr> -<tr> -<td>hexchatdir </td> -<td> HexChat config directory, e.g.: /home/user/.config/hexchat.</td> -</tr> </table><br> </td> </tr> @@ -724,7 +724,7 @@ The following fields are currently defined: <tr valign=top> <td align=right nowrap><b>See Also:</b></td> -<td><a href='#away'>away</a>, <a href='#channel'>channel</a>, <a href='#host'>host</a>, <a href='#me'>me</a>, <a href='#network'>network</a>, <a href='#server'>server</a>, <a href='#topic'>topic</a>, <a href='#version'>version</a>, <a href='#hexchatdir'>hexchatdir</a></td> +<td><a href='#away'>away</a>, <a href='#channel'>channel</a>, <a href='#host'>host</a>, <a href='#me'>me</a>, <a href='#network'>network</a>, <a href='#server'>server</a>, <a href='#topic'>topic</a>, <a href='#version'>version</a>, <a href='#configdir'>configdir</a></td> </tr> @@ -3581,7 +3581,7 @@ print "[timers]"</pre></td> <tr valign=top> <td align=right nowrap><b>See Also:</b></td> -<td><a href='#hexchatdir'>hexchatdir</a></td> +<td><a href='#configdir'>configdir</a></td> </tr> @@ -3594,17 +3594,17 @@ print "[timers]"</pre></td> <p> -<a name='hexchatdir'> </a> +<a name='configdir'> </a> <table width=100% border=0 bgcolor=#eeeeee cellpadding=3 cellspacing=0> <tr valign=top> <td align=right width=1% ><b>Name:</b></td> -<td>hexchatdir - Returns the current HexChat config directory.</td> +<td>configdir - Returns the current HexChat config directory.</td> </tr> <tr valign=top> <td align=right><b>Synopsis:</b></td> -<td><pre>hexchatdir</pre></td> +<td><pre>configdir</pre></td> </tr> <tr valign=top> @@ -3614,7 +3614,7 @@ print "[timers]"</pre></td> <tr valign=top> <td align=right><b>Example:</b></td> -<td><pre>print "My XChat config directory is [hexchatdir]"</pre></td> +<td><pre>print "My XChat config directory is [configdir]"</pre></td> </tr> <tr valign=top> |