From 29f7a9180caa1b8278bf3d9c6a9b49a0b59a1000 Mon Sep 17 00:00:00 2001 From: Berke Viktor Date: Tue, 30 Oct 2012 09:59:58 +0100 Subject: Rebrand get_info(xchatdir) but remain compatible for Perl and Python --- share/doc/perl.md | 8 ++++---- share/doc/plugins.md | 4 ++-- share/doc/python.md | 2 +- share/doc/tcl.md | 20 ++++++++++---------- 4 files changed, 17 insertions(+), 17 deletions(-) (limited to 'share/doc') diff --git a/share/doc/perl.md b/share/doc/perl.md index d1553c65..b139c5bb 100644 --- a/share/doc/perl.md +++ b/share/doc/perl.md @@ -501,14 +501,14 @@ a context cannot be found.

- xchatdir xchat config directory encoded in UTF-8
+ hexchatdir HexChat config directory encoded in UTF-8
examples:
- /home/user/.xchat2
- C:\Documents and Settings\user\Application Data\X-Chat 2 + /home/user/.config/hexchat
+ C:\Users\user\Appdata\Roaming\HexChat - xchatdirfs same as xchatdir except encoded in the locale file system encoding + hexchatdirfs same as hexchatdir except encoded in the locale file system encoding

This function is used to retrieve certain information about the current diff --git a/share/doc/plugins.md b/share/doc/plugins.md index bf000701..0645ff46 100644 --- a/share/doc/plugins.md +++ b/share/doc/plugins.md @@ -834,8 +834,8 @@ Changed in 2.6.1. If _servname_ is NULL, it finds the channel (or query) by the versionHexChat version number. win_ptrnative window pointer. Unix: (GtkWindow *) Win32: HWND (since 2.6.0). win_statuswindow status: "active", "hidden" or "normal" (since 2.0.9). - xchatdirHexChat 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. - xchatdirfsHexChat config directory, e.g.: /home/user/.config/hexchat (since 2.0.9).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 xchatdirfs, but xchatdir instead. + hexchatdirHexChat 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. + hexchatdirfsHexChat 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. diff --git a/share/doc/python.md b/share/doc/python.md index 9593ff82..9480810a 100644 --- a/share/doc/python.md +++ b/share/doc/python.md @@ -162,7 +162,7 @@ are available to be queried: * **server:** Current server name (what the server claims to be) or None if you are not connected. * **topic:** Current channel topic. * **version:** HexChat version number. - * **xchatdir:** HexChat config directory e.g.: "~/.config/hexchat". + * **hexchatdir:** HexChat config directory e.g.: "~/.config/hexchat". Example: diff --git a/share/doc/tcl.md b/share/doc/tcl.md index f7ac44d7..506da056 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 Example: 

/tcl puts "Hello, XChat World!"
-/tcl xchatdir
+/tcl hexchatdir @@ -706,12 +706,12 @@ The following fields are currently defined: version - xchat version number. + HexChat version number. -xchatdir - xchat config directory, e.g.: /home/user/.xchat. +hexchatdir + HexChat config directory, e.g.: /home/user/.config/hexchat.
@@ -724,7 +724,7 @@ The following fields are currently defined: See Also: -away, channel, host, me, network, server, topic, version, xchatdir +away, channel, host, me, network, server, topic, version, hexchatdir @@ -3581,7 +3581,7 @@ print "[timers]" See Also: -xchatdir +hexchatdir @@ -3594,17 +3594,17 @@ print "[timers]"

- + - + - + @@ -3614,7 +3614,7 @@ print "[timers]" - + -- cgit 1.4.1
Name:xchatdir - Returns the current xchat config directory.hexchatdir - Returns the current HexChat config directory.
Synopsis:
xchatdir
hexchatdir
Example:
print "My XChat config directory is [xchatdir]"
print "My XChat config directory is [hexchatdir]"