Fix hyphen-minus confusion in manpages

diff --git a/doc/rspamc.1 b/doc/rspamc.1
index b0670c1ee7de69dcb51788711e850629ebc1f911..2ef02898bd5b6939f2bf85a7e2f259960227857c 100644 (file)
--- a/doc/rspamc.1
+++ b/doc/rspamc.1
@@ -1,12 +1,12 @@
-.TH RSPAMC 1 "" "Rspamd User Manual"
+.TH "RSPAMC" "1" "" "Rspamd User Manual" ""
 .SH NAME
 .PP
-rspamc - rspamd command line client
+rspamc \- rspamd command line client
 .SH SYNOPSIS
 .PP
-rspamc [\f[I]options\f[]] [\f[I]command\f[]] [\f[I]input-file\f[]]...
+rspamc [\f[I]options\f[]] [\f[I]command\f[]] [\f[I]input\-file\f[]]...
 .PP
-rspamc --help
+rspamc \-\-help
 .SH DESCRIPTION
 .PP
 Rspamc is a simple client for checking messages using rspamd or for
@@ -26,11 +26,11 @@ Control commands
 .IP \[bu] 2
 \f[I]learn_ham\f[]: learn message as ham
 .IP \[bu] 2
-\f[I]fuzzy_add\f[]: add message to fuzzy storage (check \f[C]-f\f[] and
-\f[C]-w\f[] options for this command)
+\f[I]fuzzy_add\f[]: add message to fuzzy storage (check \f[C]\\\-f\f[]
+and \f[C]\\\-w\f[] options for this command)
 .IP \[bu] 2
-\f[I]fuzzy_del\f[]: delete message from fuzzy storage (check \f[C]-f\f[]
-option for this command)
+\f[I]fuzzy_del\f[]: delete message from fuzzy storage (check
+\f[C]\\\-f\f[] option for this command)
 .IP \[bu] 2
 \f[I]stat\f[]: show rspamd statistics
 .IP \[bu] 2
@@ -47,10 +47,10 @@ graphs)
 .RE
 .PP
 Control commands that modifies rspamd state are considered as privileged
-and basically requires a password to be specified with \f[C]-P\f[]
+and basically requires a password to be specified with \f[C]\\\-P\f[]
 option (see \f[B]OPTIONS\f[], below, for details).
 This depends on a controller\[aq]s settings and is discussed in
-\f[C]rspamd-workers\f[] page.
+\f[C]rspamd\-workers\f[] page.
 .PP
 \f[C]Input\ files\f[] may be either regular file(s) or a directory to
 scan.
@@ -59,84 +59,84 @@ Controller commands usually does not accept any input, however learn*
 and fuzzy* commands requires input.
 .SH OPTIONS
 .PP
--h \f[I]host[:port]\f[], --connect=\f[I]host[:port]\f[] Specify host and
-port
+\-h \f[I]host[:port]\f[], \-\-connect=\f[I]host[:port]\f[] Specify host
+and port
 .PP
--P \f[I]password\f[], --password=\f[I]password\f[] Specify control
+\-P \f[I]password\f[], \-\-password=\f[I]password\f[] Specify control
 password
 .TP
-.B -c \f[I]name\f[], --classifier=\f[I]name\f[]
+.B \-c \f[I]name\f[], \-\-classifier=\f[I]name\f[]
 Classifier to learn spam or ham (bayes is used by default)
 .RS
 .RE
 .TP
-.B -w \f[I]weight\f[], --weight=\f[I]weight\f[]
+.B \-w \f[I]weight\f[], \-\-weight=\f[I]weight\f[]
 Weight for fuzzy operations
 .RS
 .RE
 .TP
-.B -f \f[I]number\f[], --flag=\f[I]number\f[]
+.B \-f \f[I]number\f[], \-\-flag=\f[I]number\f[]
 Flag for fuzzy operations
 .RS
 .RE
 .TP
-.B -p, --pass
+.B \-p, \-\-pass
 Pass all filters
 .RS
 .RE
 .TP
-.B -v, --verbose
+.B \-v, \-\-verbose
 More verbose output
 .RS
 .RE
 .TP
-.B -i \f[I]ip address\f[], --ip=\f[I]ip address\f[]
+.B \-i \f[I]ip address\f[], \-\-ip=\f[I]ip address\f[]
 Emulate that message was received from specified ip address
 .RS
 .RE
 .TP
-.B -u \f[I]username\f[], --user=\f[I]username\f[]
+.B \-u \f[I]username\f[], \-\-user=\f[I]username\f[]
 Emulate that message was from specified user
 .RS
 .RE
 .TP
-.B -d \f[I]user\@domain\f[], --deliver=\f[I]user\@domain\f[]
+.B \-d \f[I]user\@domain\f[], \-\-deliver=\f[I]user\@domain\f[]
 Emulate that message is delivered to specified user
 .RS
 .RE
 .TP
-.B -F \f[I]user\@domain\f[], --from=\f[I]user\@domain\f[]
+.B \-F \f[I]user\@domain\f[], \-\-from=\f[I]user\@domain\f[]
 Emulate that message is from specified user
 .RS
 .RE
 .TP
-.B -r \f[I]user\@domain\f[], --rcpt=\f[I]user\@domain\f[]
+.B \-r \f[I]user\@domain\f[], \-\-rcpt=\f[I]user\@domain\f[]
 Emulate that message is for specified user
 .RS
 .RE
 .TP
-.B --helo=\f[I]helo_string\f[]
+.B \-\-helo=\f[I]helo_string\f[]
 Imitate SMTP HELO passing from MTA
 .RS
 .RE
 .TP
-.B --hostname=\f[I]hostname\f[]
+.B \-\-hostname=\f[I]hostname\f[]
 Imitate hostname passing from MTA (rspamd assumes that it is verified by
 MTA)
 .RS
 .RE
 .TP
-.B -t \f[I]seconds\f[], --timeout=\f[I]seconds\f[]
+.B \-t \f[I]seconds\f[], \-\-timeout=\f[I]seconds\f[]
 Timeout for waiting for a reply
 .RS
 .RE
 .TP
-.B -b \f[I]host:port\f[], --bind=\f[I]host:port\f[]
+.B \-b \f[I]host:port\f[], \-\-bind=\f[I]host:port\f[]
 Bind to specified ip address
 .RS
 .RE
 .TP
-.B --commands
+.B \-\-commands
 List available commands
 .RS
 .RE
@@ -166,7 +166,7 @@ Learn files:
 .IP
 .nf
 \f[C]
-rspamc\ -P\ pass\ learn_spam\ file1\ file2\ file3
+rspamc\ \\\-P\ pass\ learn_spam\ file1\ file2\ file3
 \f[]
 .fi
 .PP
@@ -174,7 +174,7 @@ Add fuzzy hash to set 2:
 .IP
 .nf
 \f[C]
-rspamc\ -P\ pass\ -f\ 2\ -w\ 10\ fuzzy_add\ file1\ file2
+rspamc\ \\\-P\ pass\ \\\-f\ 2\ \\\-w\ 10\ fuzzy_add\ file1\ file2
 \f[]
 .fi
 .PP
@@ -182,7 +182,7 @@ Delete fuzzy hash from other server:
 .IP
 .nf
 \f[C]
-rspamc\ -P\ pass\ -h\ hostname:11334\ -f\ 2\ fuzzy_del\ file1\ file2
+rspamc\ \\\-P\ pass\ \\\-h\ hostname:11334\ \\\-f\ 2\ fuzzy_del\ file1\ file2
 \f[]
 .fi
 .PP

diff --git a/doc/rspamc.1.md b/doc/rspamc.1.md
index b28e72609e0a9fd5062ff13a516f55947a006df5..76922d8c6c79e820363015dce74a979424b0e03c 100644 (file)
--- a/doc/rspamc.1.md
+++ b/doc/rspamc.1.md
@@ -8,7 +8,7 @@ rspamc - rspamd command line client
 
 rspamc [*options*] [*command*] [*input-file*]...
 
-rspamc --help
+rspamc \-\-help
 
 # DESCRIPTION
 
@@ -20,8 +20,8 @@ Rspamc supports the following commands:
 * Control commands
        * *learn_spam*: learn message as spam
        * *learn_ham*: learn message as ham
-       * *fuzzy_add*: add message to fuzzy storage (check `-f` and `-w` options for this command)
-       * *fuzzy_del*: delete message from fuzzy storage (check `-f` option for this command)
+       * *fuzzy_add*: add message to fuzzy storage (check `\-f` and `\-w` options for this command)
+       * *fuzzy_del*: delete message from fuzzy storage (check `\-f` option for this command)
        * *stat*: show rspamd statistics
        * *stat_reset*: show and reset rspamd statistics (useful for graphs)
        * *counters*: display rspamd symbols statistics
@@ -30,7 +30,7 @@ Rspamc supports the following commands:
        * *add_action*: add or modify action settings
 
 Control commands that modifies rspamd state are considered as privileged and basically requires a password
-to be specified with `-P` option (see **OPTIONS**, below, for details). 
+to be specified with `\-P` option (see **OPTIONS**, below, for details). 
 This depends on a controller's settings and is discussed in `rspamd-workers` page.
 
 `Input files` may be either regular file(s) or a directory to scan. If no files are specified rspamc reads
@@ -39,10 +39,10 @@ requires input.
 
 # OPTIONS
 
--h *host[:port]*, \--connect=*host[:port]*
+\-h *host[:port]*, \--connect=*host[:port]*
        Specify host and port
        
--P *password*, \--password=*password*
+\-P *password*, \--password=*password*
        Specify control password
        
 -c *name*, \--classifier=*name*
@@ -106,15 +106,15 @@ Check files:
        
 Learn files:
 
-       rspamc -P pass learn_spam file1 file2 file3
+       rspamc \-P pass learn_spam file1 file2 file3
 
 Add fuzzy hash to set 2:
        
-       rspamc -P pass -f 2 -w 10 fuzzy_add file1 file2
+       rspamc \-P pass \-f 2 \-w 10 fuzzy_add file1 file2
        
 Delete fuzzy hash from other server:
 
-       rspamc -P pass -h hostname:11334 -f 2 fuzzy_del file1 file2
+       rspamc \-P pass \-h hostname:11334 \-f 2 fuzzy_del file1 file2
        
 Get statistics:
        

diff --git a/doc/rspamd.8 b/doc/rspamd.8
index 37650ebaa0509572efe16cfa5c1256efe0ad5b95..96e91724fd4243496dbc8dbf48f5a2b18f16a79f 100644 (file)
--- a/doc/rspamd.8
+++ b/doc/rspamd.8
@@ -1,12 +1,12 @@
-.TH RSPAMD 8 "" "Rspamd User Manual"
+.TH "RSPAMD" "8" "" "Rspamd User Manual" ""
 .SH NAME
 .PP
-rspamd - main daemon for rapid spam filtering system
+rspamd \- main daemon for rapid spam filtering system
 .SH SYNOPSIS
 .PP
 rspamd [\f[I]options\f[]]...
 .PP
-rspamd --help
+rspamd \-\-help
 .SH DESCRIPTION
 .PP
 Rspamd filtering system is designed to be fast, modular and easily
@@ -18,67 +18,67 @@ Rspamd is designed to process connections completely asynchronous and do
 not block anywhere in code.
 .SH OPTIONS
 .TP
-.B -t, --config-test
+.B \-t, \-\-config\-test
 Perform config test and exit
 .RS
 .RE
 .TP
-.B -f, --no-fork
+.B \-f, \-\-no\-fork
 Do not daemonize main process
 .RS
 .RE
 .TP
-.B -c \f[I]path\f[], --config=\f[I]path\f[]
+.B \-c \f[I]path\f[], \-\-config=\f[I]path\f[]
 Specify config file(s)
 .RS
 .RE
 .TP
-.B -u \f[I]username\f[], --user=\f[I]username\f[]
+.B \-u \f[I]username\f[], \-\-user=\f[I]username\f[]
 User to run rspamd as
 .RS
 .RE
 .TP
-.B -g \f[I]groupname\f[], --group=\f[I]groupname\f[]
+.B \-g \f[I]groupname\f[], \-\-group=\f[I]groupname\f[]
 Group to run rspamd as
 .RS
 .RE
 .TP
-.B -p \f[I]path\f[], --pid=\f[I]path\f[]
+.B \-p \f[I]path\f[], \-\-pid=\f[I]path\f[]
 Path to pidfile
 .RS
 .RE
 .TP
-.B -C, --dump-cache
+.B \-C, \-\-dump\-cache
 Dump symbols cache stats and exit
 .RS
 .RE
 .TP
-.B -d, --debug
+.B \-d, \-\-debug
 Force debug output
 .RS
 .RE
 .TP
-.B -i, --insecure
+.B \-i, \-\-insecure
 Ignore running workers as privileged users (insecure)
 .RS
 .RE
 .TP
-.B --test-lua=\f[I]path\f[]
+.B \-\-test\-lua=\f[I]path\f[]
 Specify lua file(s) to test
 .RS
 .RE
 .TP
-.B --sign-config=\f[I]path\f[]
+.B \-\-sign\-config=\f[I]path\f[]
 Specify config file(s) to sign
 .RS
 .RE
 .TP
-.B --private-key=\f[I]path\f[]
+.B \-\-private\-key=\f[I]path\f[]
 Specify private key to sign
 .RS
 .RE
 .TP
-.B --convert-config=\f[I]path\f[]
+.B \-\-convert\-config=\f[I]path\f[]
 Convert configuration to UCL
 .RS
 .RE
@@ -96,7 +96,7 @@ Run rspamd in foreground with custom configuration:
 .IP
 .nf
 \f[C]
-rspamd\ -f\ -c\ ~/rspamd.conf
+rspamd\ \\\-f\ \\\-c\ ~/rspamd.conf
 \f[]
 .fi
 .PP
@@ -104,7 +104,7 @@ Run rspamd specifying user and group:
 .IP
 .nf
 \f[C]
-rspamd\ -u\ rspamd\ -g\ rspamd\ -c\ /etc/rspamd/rspamd.conf
+rspamd\ \\\-u\ rspamd\ \\\-g\ rspamd\ \\\-c\ /etc/rspamd/rspamd.conf
 \f[]
 .fi
 .PP
@@ -112,15 +112,15 @@ Test lua scripts using rspamd API:
 .IP
 .nf
 \f[C]
-rspamd\ --test-lua=~/test1.lua\ --test-lua=~/test2.lua
+rspamd\ \\\-\\\-test\-lua=~/test1.lua\ \\\-\\\-test\-lua=~/test2.lua
 \f[]
 .fi
 .PP
-Sign config files for \f[C].includes\f[] macro:
+Sign config files for \f[C]\&.includes\f[] macro:
 .IP
 .nf
 \f[C]
-rspamd\ --private-key=sign.key\ --sign-config=rspamd.conf
+rspamd\ \\\-\\\-private\-key=sign.key\ \\\-\\\-sign\-config=rspamd.conf
 \f[]
 .fi
 .PP
@@ -129,7 +129,7 @@ Convert old \f[C]XML\f[] config to the \f[C]UCL\f[] format (since
 .IP
 .nf
 \f[C]
-rspamd\ -c\ /etc/rspamd.xml\ --convert-config=/etc/rspamd/rspamd.conf
+rspamd\ \\\-c\ /etc/rspamd.xml\ \\\-\\\-convert\-config=/etc/rspamd/rspamd.conf
 \f[]
 .fi
 .SH SEE ALSO

diff --git a/doc/rspamd.8.md b/doc/rspamd.8.md
index 2e6d60b4857d2cdfe552a9fba7e26897ca1bf380..7991356c9239e87d518030d765c9a936e993381f 100644 (file)
--- a/doc/rspamd.8.md
+++ b/doc/rspamd.8.md
@@ -8,7 +8,7 @@ rspamd - main daemon for rapid spam filtering system
 
 rspamd [*options*]...
 
-rspamd --help
+rspamd \--help
 
 # DESCRIPTION
 
@@ -66,23 +66,23 @@ Run rspamd daemon with default configuration:
        
 Run rspamd in foreground with custom configuration:
 
-       rspamd -f -c ~/rspamd.conf
+       rspamd \-f \-c ~/rspamd.conf
        
 Run rspamd specifying user and group:
 
-       rspamd -u rspamd -g rspamd -c /etc/rspamd/rspamd.conf
+       rspamd \-u rspamd \-g rspamd \-c /etc/rspamd/rspamd.conf
 
 Test lua scripts using rspamd API:
 
-       rspamd --test-lua=~/test1.lua --test-lua=~/test2.lua
+       rspamd \-\-test-lua=~/test1.lua \-\-test-lua=~/test2.lua
 
 Sign config files for `.includes` macro:
 
-       rspamd --private-key=sign.key --sign-config=rspamd.conf
+       rspamd \-\-private-key=sign.key \-\-sign-config=rspamd.conf
 
 Convert old `XML` config to the `UCL` format (since 0.6.0):
 
-       rspamd -c /etc/rspamd.xml --convert-config=/etc/rspamd/rspamd.conf
+       rspamd \-c /etc/rspamd.xml \-\-convert-config=/etc/rspamd/rspamd.conf
 
 # SEE ALSO