summaryrefslogtreecommitdiff
path: root/doc/en
diff options
context:
space:
mode:
authorSébastien Helleu <flashcode@flashtux.org>2016-05-03 22:58:13 +0200
committerSébastien Helleu <flashcode@flashtux.org>2016-05-14 09:42:57 +0200
commitde24a7cb7bec64bb724cbf66845668a58cc9e56f (patch)
treeb9dabaf483fad553cf124ac917e68f7bf54e6031 /doc/en
parent220bd837aea2fac67594b8b62291f306f70a6230 (diff)
downloadweechat-de24a7cb7bec64bb724cbf66845668a58cc9e56f.zip
doc: fix styles in man page (issue #722)
Diffstat (limited to 'doc/en')
-rw-r--r--doc/en/CMakeLists.txt2
-rw-r--r--doc/en/cmdline_options.en.asciidoc6
-rw-r--r--doc/en/weechat.1.en.asciidoc34
3 files changed, 22 insertions, 20 deletions
diff --git a/doc/en/CMakeLists.txt b/doc/en/CMakeLists.txt
index c76826376..76aee25aa 100644
--- a/doc/en/CMakeLists.txt
+++ b/doc/en/CMakeLists.txt
@@ -21,7 +21,7 @@ if(ENABLE_MAN)
# man page
add_custom_command(
OUTPUT ${CMAKE_CURRENT_BINARY_DIR}/weechat.1
- COMMAND ${ASCIIDOCTOR_EXECUTABLE} ARGS -a revision='WeeChat ${VERSION}' -b manpage -o weechat.1 ${CMAKE_CURRENT_SOURCE_DIR}/weechat.1.en.asciidoc
+ COMMAND ${ASCIIDOCTOR_EXECUTABLE} ARGS ${ASCIIDOCTOR_ARGS} -b manpage -o weechat.1 ${CMAKE_CURRENT_SOURCE_DIR}/weechat.1.en.asciidoc
DEPENDS
${CMAKE_CURRENT_SOURCE_DIR}/weechat.1.en.asciidoc
${CMAKE_CURRENT_SOURCE_DIR}/cmdline_options.en.asciidoc
diff --git a/doc/en/cmdline_options.en.asciidoc b/doc/en/cmdline_options.en.asciidoc
index 54e2136d4..82a1c8fb8 100644
--- a/doc/en/cmdline_options.en.asciidoc
+++ b/doc/en/cmdline_options.en.asciidoc
@@ -4,9 +4,9 @@
*-c*, *--colors*::
Display default colors in terminal.
-*-d*, *--dir* '<path>'::
+*-d*, *--dir* _<path>_::
Set path as home for WeeChat (used for configuration files, logs, user
- plugins and scripts), default value is '~/.weechat' (note: directory is
+ plugins and scripts), default value is "~/.weechat" (note: directory is
created if not found by WeeChat).
If this option is not given, the environment variable WEECHAT_HOME is used
(if not empty).
@@ -20,7 +20,7 @@
*-p*, *--no-plugin*::
Disable plugins auto-load.
-*-r*, *--run-command* '<command>'::
+*-r*, *--run-command* _<command>_::
Run command(s) after startup (many commands can be separated by semicolons).
*-s*, *--no-script*::
diff --git a/doc/en/weechat.1.en.asciidoc b/doc/en/weechat.1.en.asciidoc
index 8d412f587..bb5ae4850 100644
--- a/doc/en/weechat.1.en.asciidoc
+++ b/doc/en/weechat.1.en.asciidoc
@@ -1,8 +1,10 @@
-= WEECHAT(1)
+= weechat(1)
:doctype: manpage
:author: Sébastien Helleu
:email: flashcode@flashtux.org
:lang: en
+:man manual: WeeChat Manual
+:man source: WeeChat {revnumber}
== NAME
@@ -11,11 +13,11 @@ weechat - the extensible chat client
== SYNOPSIS
[verse]
-'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' [-l|--license]
-'weechat' [-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* [-l|--license]
+*weechat* [-v|--version]
== DESCRIPTION
@@ -57,34 +59,34 @@ $HOME/.weechat/sec.conf::
configuration file with secured data
$HOME/.weechat/alias.conf::
- configuration file for 'alias' plugin
+ configuration file for _alias_ plugin
$HOME/.weechat/aspell.conf::
- configuration file for 'aspell' plugin
+ configuration file for _aspell_ plugin
$HOME/.weechat/charset.conf::
- configuration file for 'charset' plugin
+ configuration file for _charset_ plugin
$HOME/.weechat/exec.conf::
- configuration file for 'exec' plugin
+ configuration file for _exec_ plugin
$HOME/.weechat/irc.conf::
- configuration file for 'irc' plugin
+ configuration file for _irc_ plugin
$HOME/.weechat/logger.conf::
- configuration file for 'logger' plugin
+ configuration file for _logger_ plugin
$HOME/.weechat/relay.conf::
- configuration file for 'relay' plugin
+ configuration file for _relay_ plugin
$HOME/.weechat/script.conf::
- configuration file for 'script' plugin
+ configuration file for _script_ plugin
$HOME/.weechat/trigger.conf::
- configuration file for 'trigger' plugin
+ configuration file for _trigger_ plugin
$HOME/.weechat/xfer.conf::
- configuration file for 'xfer' plugin
+ configuration file for _xfer_ plugin
$HOME/.weechat/weechat.log::
WeeChat log file