summaryrefslogtreecommitdiff
path: root/doc/en
diff options
context:
space:
mode:
Diffstat (limited to 'doc/en')
-rw-r--r--doc/en/CMakeLists.txt12
-rw-r--r--doc/en/Makefile.am12
-rw-r--r--doc/en/autogen/user/weechat_commands.txt2
-rw-r--r--doc/en/weechat.1.en.txt (renamed from doc/en/weechat-curses.1.en.txt)18
-rw-r--r--doc/en/weechat_dev.en.txt3
-rw-r--r--doc/en/weechat_faq.en.txt8
-rw-r--r--doc/en/weechat_quickstart.en.txt2
-rw-r--r--doc/en/weechat_tester.en.txt32
-rw-r--r--doc/en/weechat_user.en.txt16
9 files changed, 54 insertions, 51 deletions
diff --git a/doc/en/CMakeLists.txt b/doc/en/CMakeLists.txt
index ae9a03d15..dd310de53 100644
--- a/doc/en/CMakeLists.txt
+++ b/doc/en/CMakeLists.txt
@@ -20,15 +20,15 @@
IF(ENABLE_MAN)
# man page
ADD_CUSTOM_COMMAND(
- OUTPUT ${CMAKE_CURRENT_BINARY_DIR}/weechat-curses.1
- COMMAND ${A2X_EXECUTABLE} ARGS -a revision='WeeChat ${VERSION}' -d manpage -f manpage -L -D ${CMAKE_CURRENT_BINARY_DIR} ${CMAKE_CURRENT_SOURCE_DIR}/weechat-curses.1.en.txt
+ OUTPUT ${CMAKE_CURRENT_BINARY_DIR}/weechat.1
+ COMMAND ${A2X_EXECUTABLE} ARGS -a revision='WeeChat ${VERSION}' -d manpage -f manpage -L -D ${CMAKE_CURRENT_BINARY_DIR} ${CMAKE_CURRENT_SOURCE_DIR}/weechat.1.en.txt
DEPENDS
- ${CMAKE_CURRENT_SOURCE_DIR}/weechat-curses.1.en.txt
+ ${CMAKE_CURRENT_SOURCE_DIR}/weechat.1.en.txt
${CMAKE_CURRENT_SOURCE_DIR}/cmdline_options.en.txt
- COMMENT "Building weechat-curses.1 (en)"
+ COMMENT "Building weechat.1 (en)"
)
- ADD_CUSTOM_TARGET(doc-man-en ALL DEPENDS ${CMAKE_CURRENT_BINARY_DIR}/weechat-curses.1)
- INSTALL(FILES ${CMAKE_CURRENT_BINARY_DIR}/weechat-curses.1 DESTINATION ${MANDIR}/man1)
+ ADD_CUSTOM_TARGET(doc-man-en ALL DEPENDS ${CMAKE_CURRENT_BINARY_DIR}/weechat.1)
+ INSTALL(FILES ${CMAKE_CURRENT_BINARY_DIR}/weechat.1 DESTINATION ${MANDIR}/man1)
ENDIF(ENABLE_MAN)
IF(ENABLE_DOC AND SOURCEHIGHLIGHT_FOUND)
diff --git a/doc/en/Makefile.am b/doc/en/Makefile.am
index 836b6c2d4..d219e9954 100644
--- a/doc/en/Makefile.am
+++ b/doc/en/Makefile.am
@@ -21,7 +21,7 @@
docdir = $(datadir)/doc/$(PACKAGE)
EXTRA_DIST = CMakeLists.txt \
- weechat-curses.1.en.txt \
+ weechat.1.en.txt \
cmdline_options.en.txt \
weechat_user.en.txt \
weechat_plugin_api.en.txt \
@@ -35,7 +35,7 @@ EXTRA_DIST = CMakeLists.txt \
$(wildcard autogen/plugin_api/*.txt)
if MAN
- man_targets = weechat-curses.1
+ man_targets = weechat.1
man_install = install-man
man_uninstall = uninstall-man
endif
@@ -54,8 +54,8 @@ endif
all-local: $(man_targets) $(doc_targets)
# man page
-weechat-curses.1: weechat-curses.1.en.txt cmdline_options.en.txt
- $(A2X) -a revision="WeeChat $(VERSION)" -d manpage -f manpage -L -D . $(abs_top_srcdir)/doc/en/weechat-curses.1.en.txt
+weechat.1: weechat.1.en.txt cmdline_options.en.txt
+ $(A2X) -a revision="WeeChat $(VERSION)" -d manpage -f manpage -L -D . $(abs_top_srcdir)/doc/en/weechat.1.en.txt
# user's guide
weechat_user.en.html: weechat_user.en.txt cmdline_options.en.txt $(wildcard autogen/user/*.txt)
@@ -106,7 +106,7 @@ install-doc:
uninstall-hook: $(man_uninstall) $(doc_uninstall)
uninstall-man:
- $(RM) $(DESTDIR)$(mandir)/man1/weechat-curses.1
+ $(RM) $(DESTDIR)$(mandir)/man1/weechat.1
-rmdir $(DESTDIR)$(mandir)/man1
uninstall-doc:
@@ -116,5 +116,5 @@ uninstall-doc:
# clean
clean-local:
- -rm -f weechat-curses.1
+ -rm -f weechat.1
-rm -f *.html
diff --git a/doc/en/autogen/user/weechat_commands.txt b/doc/en/autogen/user/weechat_commands.txt
index bff3a5d01..3b6a3e8f2 100644
--- a/doc/en/autogen/user/weechat_commands.txt
+++ b/doc/en/autogen/user/weechat_commands.txt
@@ -680,7 +680,7 @@ With option "-quit", the process is slightly different:
3. unload all plugins
4. save WeeChat configuration
5. quit WeeChat
-Then later you can restore session with command: weechat-curses --upgrade
+Then later you can restore session with command: weechat --upgrade
IMPORTANT: you must restore the session with exactly same configuration (files *.conf).
It is possible to restore WeeChat session on another machine if you copy the content of directory "~/.weechat".
........................................
diff --git a/doc/en/weechat-curses.1.en.txt b/doc/en/weechat.1.en.txt
index ca7d7740e..e608fed2f 100644
--- a/doc/en/weechat-curses.1.en.txt
+++ b/doc/en/weechat.1.en.txt
@@ -1,22 +1,22 @@
-WEECHAT-CURSES(1)
-=================
+WEECHAT(1)
+==========
:doctype: manpage
NAME
----
-weechat-curses - the extensible chat client (Curses version)
+weechat - the extensible chat client
SYNOPSIS
--------
[verse]
-'weechat-curses' [-a|--no-connect] [-d|--dir <path>] [-p|--no-plugin] [-r|--run-command <command>] [-s|--no-script] [--upgrade] [plugin:option...]
-'weechat-curses' [-c|--colors]
-'weechat-curses' [-h|--help]
-'weechat-curses' [-k|--keys]
-'weechat-curses' [-l|--license]
-'weechat-curses' [-v|--version]
+'weechat' [-a|--no-connect] [-d|--dir <path>] [-p|--no-plugin] [-r|--run-command <command>] [-s|--no-script] [--upgrade] [plugin:option...]
+'weechat' [-c|--colors]
+'weechat' [-h|--help]
+'weechat' [-k|--keys]
+'weechat' [-l|--license]
+'weechat' [-v|--version]
DESCRIPTION
-----------
diff --git a/doc/en/weechat_dev.en.txt b/doc/en/weechat_dev.en.txt
index dc55acb99..e05032e06 100644
--- a/doc/en/weechat_dev.en.txt
+++ b/doc/en/weechat_dev.en.txt
@@ -289,9 +289,8 @@ Documentation files:
| asciidoc.conf | Asciidoc configuration file (some macros)
| asciidoc.css | Asciidoc style
| docgen.py | Python script to build files in "autogen/" directory (see below)
-| weechat-curses.1 | Weechat man page
| XX/ | Documentation for language XX (languages: en, fr, de, it, ...)
-| weechat-curses.1.XX.txt | Man page
+| weechat.1.XX.txt | Man page
| weechat_quickstart.XX.txt | Quickstart guide
| weechat_user.XX.txt | User's guide
| weechat_faq.XX.txt | FAQ
diff --git a/doc/en/weechat_faq.en.txt b/doc/en/weechat_faq.en.txt
index 3990db171..7a20cba64 100644
--- a/doc/en/weechat_faq.en.txt
+++ b/doc/en/weechat_faq.en.txt
@@ -79,8 +79,8 @@ I don't see some chars with accents, what can I do?
It's common issue, please read carefully and check *ALL* solutions below:
-* check that weechat-curses is linked to libncursesw (warning: needed on most
- distributions but not all): `ldd /path/to/weechat-curses`
+* check that weechat is linked to libncursesw (warning: needed on most
+ distributions but not all): `ldd /path/to/weechat`
* check that the "Charset" plugin is loaded with `/plugin` command (if it is
not, then you probably need the "weechat-plugins" package)
* check the output of command `/charset` (on core buffer). You should see
@@ -748,7 +748,7 @@ When I run WeeChat under gdb, there is error about threads, what can I do?
When you run WeeChat under gdb, you may have this error:
----------------------------------------
-$ gdb /path/to/weechat-curses
+$ gdb /path/to/weechat
(gdb) run
[Thread debugging using libthread_db enabled]
Cannot find new threads: generic error
@@ -758,7 +758,7 @@ To fix that, you can run gdb with this command (replace path to libpthread and
WeeChat with paths on your system):
----------------------------------------
-$ LD_PRELOAD=/lib/libpthread.so.0 gdb /path/to/weechat-curses
+$ LD_PRELOAD=/lib/libpthread.so.0 gdb /path/to/weechat
(gdb) run
----------------------------------------
diff --git a/doc/en/weechat_quickstart.en.txt b/doc/en/weechat_quickstart.en.txt
index c2166e7c6..d556d3c8e 100644
--- a/doc/en/weechat_quickstart.en.txt
+++ b/doc/en/weechat_quickstart.en.txt
@@ -13,7 +13,7 @@ A recommended terminal emulator for X (but not mandatory) is rxvt-unicode
Run from your shell:
----------------------------------------
-$ weechat-curses
+$ weechat
----------------------------------------
diff --git a/doc/en/weechat_tester.en.txt b/doc/en/weechat_tester.en.txt
index d50ba61e2..fff8f2377 100644
--- a/doc/en/weechat_tester.en.txt
+++ b/doc/en/weechat_tester.en.txt
@@ -36,7 +36,9 @@ info, to know exactly where is problem in WeeChat.
If you're using the 'bash' shell, add following line to your `~/.bashrc`:
- ulimit -c unlimited
+----------------------------------------
+ulimit -c unlimited
+----------------------------------------
[[download]]
@@ -57,48 +59,48 @@ Get and build sources
First create a directory, for example 'weechat-git':
----------------------
+----------------------------------------
$ mkdir ~/weechat-git
$ cd ~/weechat-git
----------------------
+----------------------------------------
If you have git installed, you can just clone the git repository (recommended
way):
---------------------------------------------
+----------------------------------------
$ git clone git://git.sv.gnu.org/weechat.git
$ cd weechat
---------------------------------------------
+----------------------------------------
NOTE: Later, you can run "`git pull`" in this directory, to get deltas with
the latest updates.
Otherwise you can download and unpack 'devel' package:
------------------------------------------------------------------
+----------------------------------------
$ wget http://www.weechat.org/files/src/weechat-devel.tar.bz2
$ tar xvjf weechat-devel.tar.bz2
$ cd weechat-devel
------------------------------------------------------------------
+----------------------------------------
To build sources, cmake is recommended:
---------------------------------------------------------------
+----------------------------------------
$ mkdir build
$ cd build
-$ cmake .. -DPREFIX=$HOME/weechat-git -DCMAKE_BUILD_TYPE=Debug
+$ cmake .. -DPREFIX=$HOME/weechat-git -DWEECHAT_HOME=~/.weechat-dev -DCMAKE_BUILD_TYPE=Debug
$ make
$ make install
---------------------------------------------------------------
+----------------------------------------
If you don't have cmake, it's still possible to use autotools:
-----------------------------------------------------------
+----------------------------------------
$ ./autogen.sh
-$ ./configure --prefix=$HOME/weechat-git
+$ ./configure --prefix=$HOME/weechat-git WEECHAT_HOME=~/.weechat-dev
$ make
$ make install
-----------------------------------------------------------
+----------------------------------------
[[install_binary_package]]
Install binary package
@@ -121,7 +123,9 @@ version), with option `--dir`.
Command is:
- ~/weechat-git/bin/weechat-curses --dir ~/.weechat-dev
+----------------------------------------
+$ ~/weechat-git/bin/weechat
+----------------------------------------
If you're still awake you should see the familiar interface and brag about
having the newest possible version of WeeChat. ;)
diff --git a/doc/en/weechat_user.en.txt b/doc/en/weechat_user.en.txt
index dc1e404c8..9279eb3d9 100644
--- a/doc/en/weechat_user.en.txt
+++ b/doc/en/weechat_user.en.txt
@@ -368,16 +368,16 @@ When WeeChat crashes, your system will create a file 'core' or 'core.12345'
This file is created in directory where you have run WeeChat (this is *not*
directory where WeeChat is installed!).
-For example if 'weechat-curses' is installed in '/usr/bin/' and 'core' file is
+For example if 'weechat' is installed in '/usr/bin/' and 'core' file is
in '/home/xxx/', then run gdb with this command:
----------------------------------------
-gdb /usr/bin/weechat-curses /home/xxx/core
+gdb /usr/bin/weechat /home/xxx/core
----------------------------------------
[NOTE]
If you installed binary package 'weechat-dbg' (for example under Debian), then
-you can use this path for WeeChat binary: '/usr/lib/debug/usr/bin/weechat-curses'
+you can use this path for WeeChat binary: '/usr/lib/debug/usr/bin/weechat'
Then under gdb, use command `bt full` to display backtrace.
You will see something like that:
@@ -418,10 +418,10 @@ Debug a running WeeChat
^^^^^^^^^^^^^^^^^^^^^^^
To debug a running WeeChat (for example if WeeChat seems blocked), you can use
-gdb with process id (replace '12345' with PID of weechat-curses process):
+gdb with process id (replace '12345' with PID of weechat process):
----------------------------------------
-gdb /usr/bin/weechat-curses 12345
+gdb /usr/bin/weechat 12345
----------------------------------------
Then like for a crash, use command `bt full`:
@@ -445,7 +445,7 @@ include::cmdline_options.en.txt[]
To start WeeChat, issue this command:
----------------------------------------
-$ weechat-curses
+$ weechat
----------------------------------------
When you run WeeChat for the first time, a default configuration file is
@@ -1344,7 +1344,7 @@ for colors in WeeChat:
^(1)^ Even if your terminal supports more than 256 pairs, only 256 pairs can be
used in WeeChat, because of a ncurses limitation.
-You can run `weechat-curses --colors` or use command `/color` in WeeChat to
+You can run `weechat --colors` or use command `/color` in WeeChat to
display limits for your environment.
Some recommended values for 'TERM' if you want 256 colors:
@@ -1806,7 +1806,7 @@ Example to join '#weechat' and '#toto' on server 'irc.freenode.net' server,
default port (6667), with nick 'nono':
----------------------------------------
-$ weechat-curses irc://nono@irc.freenode.net/#weechat,#toto
+$ weechat irc://nono@irc.freenode.net/#weechat,#toto
----------------------------------------
[[irc_options]]
generated by cgit v1.2.3 (git 2.25.1) at 2024-10-30 19:16:57 +0000