pegasus/weechat
1
0
Fork 0
mirror of https://github.com/weechat/weechat.git synced 2026-06-26 04:46:37 +02:00
Code Activity

Fix english typos in docs (patch from jdhore)

Browse Source
This commit is contained in:
Sebastien Helleu
2009-06-13 09:43:17 +02:00
parent c95f7b8e83
commit 314687bf71
3 changed files with 96 additions and 94 deletions
Download Patch File Download Diff File Expand all files Collapse all files
doc/en/weechat_faq.en.txt
+60 -60
View File
@@ -14,15 +14,15 @@ Why choose WeeChat? X-Chat and Irssi are so good...
Because WeeChat is very light and has new features.
Some features (version > = 0.3.x):
* multi-protocols support via plugins (IRC, Jabber)
* many remote GUI in addition to Curses (coming soon)
* multi-protocol support via plugins (IRC, Jabber)
* many remote GUI's in addition to Curses (coming soon)
* available in many languages
* extensible with plugins (C, Perl, Python, Ruby, Lua, Tcl)
* buffers with free content
* display filtering by tags and regular expressions
* horizontal and vertical window split
* customizable and extensible bars
* nicklist available in all GUI
* nicklist available in all GUI's
* incremental text search in buffers, jump to highlights
* FIFO pipe for remote control
* aspell support
@@ -40,28 +40,28 @@ Compilation / install
[[gui]]
I heard about many GUI for WeeChat. How can I compile/use them?
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
I heard about many GUI's for WeeChat. How can I compile/use them?
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Today only Curses GUI is available.
Today only a Curses GUI is available.
Other GUI will be available as remote client (currently under development).
Other GUI's will be available as remote clients (currently under development).
[[compile_git]]
I can't compile WeeChat after cloning git repository, why?
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Recommended way to compile WeeChat is with cmake.
The recommended way to compile WeeChat is with cmake.
If you're compiling with autotools (and not cmake), check that you have latest
version of autoconf and automake (WeeChat is developed with autoconf 2.61 and
automake 1.10.1).
Other way is to install "devel package", which needs less dependencies. This
package is built almost every day using git repository. Note that this package
may not correspond exactly to git base and that it's less convenient than git
cloning for installing updates.
The other way is to install "devel package", which needs less dependencies.
This package is built almost every day using git repository. Note that this
package may not correspond exactly to git base and that it's less convenient
than git cloning for installing updates.
Using WeeChat
@@ -75,19 +75,19 @@ I've launched WeeChat, but I'm lost, what can I do?
For help you can type `/help`. For help about a command, type `/help command`.
Keys and commands are listed in documentation.
It's recommended for new users to read quickstart guide (see doc page on
website).
It's recommended for new users to read the quickstart guide (see the doc page
on the website).
[[buffer_vs_window]]
I heard about "buffer" and "window", what's the difference?
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
I heard about "buffers" and "windows", what's the difference?
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
A 'buffer' is composed by a number, a name, lines displayed (and some other
data).
A 'window' is a screen area which displays a buffer. It is possible to split
screen into many windows.
your screen into many windows.
Each window displays one buffer. A buffer can be hidden (not displayed by a
window) or displayed by one or more windows.
@@ -97,17 +97,17 @@ window) or displayed by one or more windows.
I don't see some chars with accents, what can I do?
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
For versions < 0.2.3, please upgrade to last stable version.
For versions < 0.2.3, please upgrade to the latest stable version.
For versions > = 0.2.3:
* check that weechat-curses is linked to libncursesw (warning: needed on most
distributions but not all): `ldd /path/to/weechat-curses`
* check that "Charset" plugin is loaded with `/plugin` command (if it is not,
then you probably need "weechat-plugins" package)
* check charset line (on server buffer), you should see 'ISO-XXXXXX' or 'UTF-8'
for terminal charset. If you see 'ANSI_X3.4-1968' or other values, your
locale is probably wrong.
* check that the "Charset" plugin is loaded with `/plugin` command (if it is
not, then you probably need the "weechat-plugins" package)
* check the charset line (on server buffer). You should see 'ISO-XXXXXX' or
'UTF-8' for terminal charset. If you see 'ANSI_X3.4-1968' or other values,
your locale is probably wrong.
* setup global decode value, for example:
** with WeeChat < = 0.2.6: `/setp charset.global.decode = ISO-8859-15`
** with WeeChat > = 0.3.x: `/set charset.default.decode "ISO-8859-15"`
@@ -127,27 +127,27 @@ and *not* UTF-8.
Bars like title and status are not filled, background color stops after text, why?
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
This may be caused by bad value of TERM variable (look at output of
`echo $TERM` in your terminal).
This may be caused by a bad value of the TERM variable in your shell (look at
output of `echo $TERM` in your terminal).
Depending on where you launch WeeChat, you should have:
* if WeeChat runs locally or on a remote machine without screen, it depends on
terminal used: 'xterm', 'rxvt', ..
the terminal used: 'xterm', 'rxvt', ..
* if WeeChat runs under screen, you should have 'screen'.
If needed, fix your TERM variable: `export TERM="xxx"`.
[[screen_weird_chars]]
When I'm using weechat under screen, I have weird random chars, how to fix that?
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
When I'm using weechat under screen, I have weird random chars, how do I fix that?
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
This may be caused by bad value of TERM variable (look at output of
`echo $TERM` in your terminal).
This may be caused by bad value of the TERM variable in your shell (look at
output of `echo $TERM` in your terminal).
For example, 'xterm-color' displays such weird chars, use 'xterm' which is ok
(like many other values).
For example, 'xterm-color' may display such weird chars, you can use 'xterm'
which is ok (like many other values).
If needed, fix your TERM variable: `export TERM="xxx"`.
@@ -163,12 +163,12 @@ command line.
[[openbsd_plugins]]
I'm using OpenBSD and WeeChat does not load any plugin, what's wrong?
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
I'm using OpenBSD and WeeChat does not load any plugins, what's wrong?
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Under OpenBSD, plugin filename ends with ".so.0.0" (".so" for Linux).
Under OpenBSD, plugin filenames end with ".so.0.0" (".so" for Linux).
You must setup that:
You must set that up:
* with WeeChat < = 0.2.6: `/set plugins_extension = ".so.0.0"`
* with WeeChat > = 0.3.x: `/set weechat.plugin.extension ".so.0.0"`
@@ -180,7 +180,7 @@ Then: `/plugin autoload`.
How can I load Perl/Python/Ruby/Lua/Tcl scripts? Are scripts compatible with other IRC clients?
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
You can use commands `/perl`, `/python`, `/ruby`, `/lua` and `/tcl` to load
You can use the commands `/perl`, `/python`, `/ruby`, `/lua` and `/tcl` to load
scripts (default path for scripts is '~/.weechat/<language>/').
Scripts are not compatible with other IRC clients.
@@ -189,15 +189,15 @@ Notes:
* scripts in '~/.weechat/<language>/autoload/' are automatically loaded when
WeeChat is starting up.
* plugin 'tcl' is available with version > = 0.3.x.
* a 'tcl' plugin is available with version > = 0.3.x.
[[change_locale_without_quit]]
I want to change language used by WeeChat for messages, but without exiting WeeChat, is it possible?
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
I want to change the language used by WeeChat for messages, but without exiting WeeChat, is it possible?
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Yes, you have to use python script shell.py (available on WeeChat website) and
issue these commands when script is loaded:
Yes, you have to use a python script, shell.py (available on WeeChat website)
and issue these commands when script is loaded:
/shell setenv LANG=en_US.UTF-8
/upgrade
@@ -207,23 +207,23 @@ can issue: `/shell setenv LANG=en_US`.
[[terminal_copy_paste]]
With Curses GUI, how can I copy/paste text without pasting nicklist?
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
With the Curses GUI, how can I copy/paste text without pasting nicklist?
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
You can use a terminal with rectangular selection (like rxvt-unicode,
konsole, ...). Key is usually ctrl + alt + mouse selection.
Other solution is to move nicklist to top or bottom, for example:
Another solution is to move nicklist to top or bottom, for example:
* with WeeChat < = 0.2.6: `set look_nicklist_position = top`
* with WeeChat > = 0.3.x: `/bar set nicklist position top`
[[highlight_notification]]
How to be warned when someone highlights me on a channel?
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
How can I be warned when someone highlights me on a channel?
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
You can use script 'sound.pl' (available on scripts page), and then setup a
You can use the script 'sound.pl' (available on scripts page), and then setup a
system command (to play sound, display message, ..) with this command:
* with WeeChat < = 0.2.6:
@@ -260,21 +260,21 @@ According to WeeChat version:
[[ignore_vs_filter]]
What is the difference between /ignore and /filter commands?
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
What is the difference between the /ignore and /filter commands?
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
The `/ignore` command is an IRC command, so it applies only for IRC buffers
(servers and channels).
It lets you ignore some nicks or hostname for a server or channel (command
will not apply on content of messages).
It lets you ignore some nicks or hostnames of users for a server or channel
(command will not apply on content of messages).
Matching messages are deleted by IRC plugin before display (so you'll
never see them).
The `/filter` command is a core command, so it applies on any buffer.
The `/filter` command is a core command, so it applies to any buffer.
It lets you filter some lines in buffers with tags or regular expression for
prefix and content of line.
Filtered lines are only hidden, not deleted, and you can see them if you
disable filters (by default, key alt + "=" toggles filters).
disable filters (by default, the key alt + "=" toggles filters).
Development
@@ -282,13 +282,13 @@ Development
[[bug_task_patch]]
How should I report bug, ask new feature or send a patch?
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
How should I report bugs, ask for new features or send patches?
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
There are 3 ways:
. you can join us on IRC: 'irc.freenode.net', channel '#weechat'
. you can use savannah website:
. you can use the savannah website:
* report a bug: https://savannah.nongnu.org/bugs/?group=weechat
* request a new feature: https://savannah.nongnu.org/task/?group=weechat
* send a patch: https://savannah.nongnu.org/patch/?group=weechat
@@ -301,11 +301,11 @@ There are 3 ways:
What is the list of supported platforms for WeeChat? Will it be ported to other operating systems?
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Full list is on this page:
The full list is on this page:
http://weechat.flashtux.org/download.php?view=supported_os
We do our best to run on as many platforms as possible. Help is welcome for
some OS we don't have, to test WeeChat.
some OS' we don't have, to test WeeChat.
[[help_developers]]
@@ -314,7 +314,7 @@ I want to help WeeChat developers. What can I do?
There's many tasks to do (testing, code, documentation, ...)
Please contact us with IRC or mail, look at support page:
Please contact us via IRC or mail, look at support page:
http://weechat.flashtux.org/support.php
doc/en/weechat_quickstart.en.txt
+19 -19
View File
@@ -18,18 +18,18 @@ Online help / options
---------------------
WeeChat has help for all commands, just issue /help
To get help on a command, issue `/help command`
To get help on a specific command, issue `/help command`
To set options, use `/set config.section.option value`
(where `config` is configuration name (`weechat` for core, or a plugin
name), `section` the section of this configuration and `option` the
option name).
WeeChat immediately uses new value (you *never* need to restart WeeChat
WeeChat immediately uses the new value (you *never* need to restart WeeChat
after changes to configuration).
You can use `/set` option with partial name and wildcard "*" at beginning or
end to display all options containg letters.
You can use `/set` option with partial name and wildcard "*" at the beginning
or end to display all options containg letters.
For example:
`/set`::
@@ -45,7 +45,7 @@ You can display help for an option with `/help`, for example:
`/help weechat.look.highlight`.
All settings are saved when WeeChat ends (or with `/save` command to force
write of options).
a write of the options).
You can edit configuration files (*.conf) by hand and reload them by
`/reload` command if you don't want to use `/set` command.
@@ -56,13 +56,13 @@ Core vs plugins
---------------
WeeChat "core" is only used to display data on screen and interact with
user, that means weechat core without plugins is useless
the user, that means weechat core without plugins is useless
(faithful users: IRC was part of core for versions < = 0.2.6).
All network protocols like IRC are provided in separate plugins.
Use `/plugin` command to list loaded plugins, you should see "irc" and
other plugins in list.
Use the `/plugin` command to list loaded plugins, you should see "irc" and
other plugins in the list.
[[create_irc_server]]
@@ -112,7 +112,7 @@ To auto-join some channels when connecting to server:
/set irc.server.oftc.autojoin "#channel1,#channel2"
To remove value of a server option, and use default value instead,
To remove a value of a server option, and use the default value instead,
for example to use default nicks (irc.server_default.nicks):
/set irc.server.oftc.nicks null
@@ -145,15 +145,15 @@ Join/part IRC channels
part a channel (keeping buffer open)
`/close [quit message]`::
close server or channel buffer (`/close` is an alias on `/buffer close`)
close server or channel buffer (`/close` is an alias for `/buffer close`)
[[buffer_window]]
Buffer/window management
------------------------
A buffer is a component linked to a plugin with a number with a category
and a name. Buffer contains data displayed on screen.
A buffer is a component linked to a plugin with a number, a category,
and a name. A buffer contains the data displayed on the screen.
A window is a view on a buffer. By default there's only one window
displaying one buffer. If you split screen, you will see many windows
@@ -166,8 +166,8 @@ Commands to manage buffers and windows:
(I'll not repeat here that you can get help with /help on these commands)
For example, to split verticaly screen into a small window (1/3 width),
and a large (2/3), use command:
For example, to vertically split your screen into a small window (1/3 width),
and a large window (2/3), use command:
/window splitv 33
@@ -176,7 +176,7 @@ and a large (2/3), use command:
Key bindings
------------
WeeChat uses many keys by default. All these keys are in documentation,
WeeChat uses many keys by default. All these keys are in the documentation,
but you should know at least some vital keys:
- 'alt + left/right arrows' (or 'F5'/'F6'): switch to previous/next buffer
@@ -213,20 +213,20 @@ On some distros like Debian, plugins are available via a separate package
Plugins are automatically loaded when found.
Some plugins let you use scripts in WeeChat (in many languages like Perl,
Python, Ruby, Lua and Tcl). These plugins must be loaded with `/plugin`
Python, Ruby, Lua and Tcl). These plugins must be loaded with the `/plugin`
command and they provide commands like `/perl`, used to load scripts.
Many external plugins/scripts (from contributors) are available for
WeeChat: http://weechat.flashtux.org/plugins.php
Please look at WeeChat documentation to load/unload plugins or scripts.
Please look at the WeeChat documentation to load/unload plugins or scripts.
[[more_doc]]
More documentation
------------------
You can now use WeeChat and read FAQ/documentation for any other question:
You can now use WeeChat and read FAQ/documentation for any other questions:
http://weechat.flashtux.org/doc.php
Enjoy WeeChat!
Enjoy using WeeChat!
doc/en/weechat_tester.en.txt
+17 -15
View File
@@ -11,17 +11,18 @@ Many thankful users ask us how can they help developing WeeChat. The
easiest (and also most tricky) way to help developing WeeChat is
testing!
Testing is very important part of software development and should not be
Testing is a very important part of software development and should not be
underestimated. When some features are implemented it should be tested, but for
some features there are too many use cases or these cases are tricky and
developers can't try out every case.
For example: notorious charset plugin introduced in WeeChat 0.2.2: noone of us
(developers, contributors and testers) used channels with national characters
in their names and when 0.2.2 was released we got flooded by russian users
blaming us. If we have more testers it should not happen again in future.
For example: A notorious charset plugin was introduced in WeeChat 0.2.2: none
of us (developers, contributors and testers) used channels with national
characters in their names and when 0.2.2 was released we got flooded by Russian
users blaming us. If we have more testers it should not happen again in the
future.
Testing stable version of WeeChat is pointless because developers are busy
Testing the stable version of WeeChat is pointless because developers are busy
implementing new stuff (and fixing old bugs) all the time.
@@ -33,7 +34,7 @@ It would help us a lot if you enable Linux 'core' files: if WeeChat crashes,
Linux will write a file called 'core'. This file contains very useful debug
info, to know exactly where is problem in WeeChat.
If you're using 'bash' shell, add following line to your `~/.bashrc`:
If you're using the 'bash' shell, add following line to your `~/.bashrc`:
ulimit -c unlimited
@@ -42,13 +43,13 @@ If you're using 'bash' shell, add following line to your `~/.bashrc`:
Download devel version
----------------------
Fresh code (with last bugs and features) is stored in GIT repository.
Fresh code (with latest bugs and features) is stored in a GIT repository.
You may decide to build it manually (recommended way):
* GIT version can be built and installed in parallel to stable version,
* you don't need root access, you don't need to sacrifice stable version of
WeeChat.
* the GIT version can be built and installed in parallel to the stable version,
* you don't need root access, and you don't need to sacrifice the stable
version of WeeChat.
[[get_sources]]
Get and build sources
@@ -61,7 +62,8 @@ $ mkdir ~/weechat-git
$ cd ~/weechat-git
---------------------
If you have git installed, you can clone git repository (recommended way):
If you have git installed, you can just clone the git repository (recommended
way):
--------------------------------------------
$ git clone git://git.sv.gnu.org/weechat.git
@@ -69,7 +71,7 @@ $ cd weechat
--------------------------------------------
NOTE: Later, you can run "`git pull`" in this directory, to get deltas with
today's version.
the latest updates.
Otherwise you can download and unpack 'devel' package:
@@ -121,8 +123,8 @@ Command is:
~/weechat-git/bin/weechat-curses --dir ~/.weechat-dev
If you're still awake you should see familiar interface and brag about
having newest possible version of WeeChat. ;)
If you're still awake you should see the familiar interface and brag about
having the newest possible version of WeeChat. ;)
Now if you experience strange behavior (it may have issues or crash or boil
your beer) don't hesitate to join `#weechat` at `irc.freenode.net` and tell us.