From: Thomas Goirand <thomas@goirand.fr>
To: mlmmj@mlmmj.org
Subject: [mlmmj] [patch] man page fixes
Date: Sun, 22 Jan 2012 09:08:52 +0000 [thread overview]
Message-ID: <4F1BD224.40908@goirand.fr> (raw)
[-- Attachment #1: Type: text/plain, Size: 355 bytes --]
Hi,
Please also apply these man page fixes. I'm currently adding this patch
in the Debian packaging to reduce lintian warnings which are quite
annoying me when working on MLMMJ: too many warnings, and I wont see
anything... By the way, hyphen-as-minus use are breaking groff
indentation, so it's a good thing to fix them.
Cheers,
Thomas Goirand (zigo)
[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #2: 10_fix_manpages_syntax.diff --]
[-- Type: text/x-diff; name="10_fix_manpages_syntax.diff", Size: 5953 bytes --]
From: Thomas Goirand <zigo@debian.org>
Subject: Fixes some of the manpages syntax
Description: Switched some UTF-8 chars and fixes some hyphen-used-as-minus-sign
Forwarded: yes
diff -u -r -N a/man/mlmmj-bounce.1 b/man/mlmmj-bounce.1
--- a/man/mlmmj-bounce.1 2012-01-22 16:58:26.000000000 +0800
+++ b/man/mlmmj-bounce.1 2012-01-22 16:59:32.000000000 +0800
@@ -3,7 +3,7 @@
mlmmj-bounce \- bounce handling utility for mlmmj
.SH SYNOPSIS
.B mlmmj-bounce
-\fI-L /path/to/list \fR[\fI-a john=doe.org | -d\fR]\fI \fR[\fI-n num | -p\fR]
+\fI\-L /path/to/list \fR[\fI\-a john=doe.org | \-d\fR]\fI \fR[\fI\-n num | \-p\fR]
.HP
\fB\-a\fR: Address string that bounces
.HP
@@ -37,6 +37,6 @@
.SH AUTHORS
This manual page was written by the following persons:
.HP
-Søren Boll Overgaard <boll@debian.org> (based on html2man output)
+Søren Boll Overgaard <boll@debian.org> (based on html2man output)
.HP
-Mads Martin Jørgensen <mmj@mmj.dk>
+Mads Martin Jørgensen <mmj@mmj.dk>
diff -u -r -N a/man/mlmmj-maintd.1 b/man/mlmmj-maintd.1
--- a/man/mlmmj-maintd.1 2012-01-22 16:58:26.000000000 +0800
+++ b/man/mlmmj-maintd.1 2012-01-22 16:59:54.000000000 +0800
@@ -3,7 +3,7 @@
mlmmj-maintd \- maintenance for mlmmj maintained lists
.SH SYNOPSIS
.B mlmmj-maintd
-[\fI-F\fR] \fI[-d\fR | \fI-L\fR] /path/to/dir
+[\fI\-F\fR] \fI[\-d\fR | \fI\-L\fR] /path/to/dir
.HP
\fB\-d\fR: Full path to directory with lists
.HP
@@ -30,10 +30,10 @@
crontab entry:
.LP
-0 */2 * * * /usr/bin/mlmmj-maintd -F -L /path/to/list
+0 */2 * * * /usr/bin/mlmmj\-maintd \-F \-L /path/to/list
.SH AUTHORS
This manual page was written by the following persons:
.HP
-Søren Boll Overgaard <boll@debian.org> (based on html2man output)
+Søren Boll Overgaard <boll@debian.org> (based on html2man output)
.HP
-Mads Martin Jørgensen <mmj@mmj.dk>
+Mads Martin Jørgensen <mmj@mmj.dk>
diff -u -r -N a/man/mlmmj-process.1 b/man/mlmmj-process.1
--- a/man/mlmmj-process.1 2012-01-22 16:58:26.000000000 +0800
+++ b/man/mlmmj-process.1 2012-01-22 16:58:57.000000000 +0800
@@ -3,7 +3,7 @@
mlmmj-process \- process mail for an mlmmj managed mailinglist
.SH SYNOPSIS
.B mlmmj-process
-\fI-L /path/to/list -m /path/to/mail \fR[\fI-h\fR] [\fI-P\fR] [\fI-V\fR]
+\fI\-L /path/to/list \-m /path/to/mail \fR[\fI-h\fR] [\fI-P\fR] [\fI-V\fR]
.HP
\fB\-h\fR: This help
.HP
@@ -61,6 +61,6 @@
.SH AUTHORS
This manual page was written by the following persons:
.HP
-Søren Boll Overgaard <boll@debian.org> (based on html2man output)
+Søren Boll Overgaard <boll@debian.org> (based on html2man output)
.HP
-Mads Martin Jørgensen <mmj@mmj.dk>
+Mads Martin Jørgensen <mmj@mmj.dk>
diff -u -r -N a/man/mlmmj-recieve.1 b/man/mlmmj-recieve.1
--- a/man/mlmmj-recieve.1 2012-01-22 16:58:26.000000000 +0800
+++ b/man/mlmmj-recieve.1 2012-01-22 16:58:57.000000000 +0800
@@ -21,7 +21,7 @@
using mailservers supporting the \fB/etc/aliases\fR file, a line to activate
an mlmmj managed mailinglist would look like this:
.LP
-list: "|/usr/bin/mlmmj-recieve -L /var/spool/mlmmj/list/"
+list: "|/usr/bin/mlmmj\-recieve \-L /var/spool/mlmmj/list/"
It's very important to specify the full path to the binary, or the mailinglist
will not function.
@@ -36,6 +36,6 @@
.SH AUTHORS
This manual page was written by the following persons:
.HP
-Søren Boll Overgaard <boll@debian.org> (based on html2man output)
+Søren Boll Overgaard <boll@debian.org> (based on html2man output)
.HP
-Mads Martin Jørgensen <mmj@mmj.dk>
+Mads Martin Jørgensen <mmj@mmj.dk>
diff -u -r -N a/man/mlmmj-send.1 b/man/mlmmj-send.1
--- a/man/mlmmj-send.1 2012-01-22 16:58:26.000000000 +0800
+++ b/man/mlmmj-send.1 2012-01-22 16:58:57.000000000 +0800
@@ -62,6 +62,6 @@
.SH AUTHORS
This manual page was written by the following persons:
.HP
-Søren Boll Overgaard <boll@debian.org> (based on html2man output)
+Søren Boll Overgaard <boll@debian.org> (based on html2man output)
.HP
-Mads Martin Jørgensen <mmj@mmj.dk>
+Mads Martin Jørgensen <mmj@mmj.dk>
diff -u -r -N a/man/mlmmj-sub.1 b/man/mlmmj-sub.1
--- a/man/mlmmj-sub.1 2012-01-22 16:58:26.000000000 +0800
+++ b/man/mlmmj-sub.1 2012-01-22 16:58:57.000000000 +0800
@@ -3,8 +3,8 @@
mlmmj-sub \- subscribe address to a mailinglist run by mlmmj
.SH SYNOPSIS
.B mlmmj-sub
-\fI-L /path/to/list -a john@doe.org \fR[\fI-c\fR | \fI-C\fR] \fR[\fI-d\fR | \fI-n\fR]
-[\fI-h\fR] [\fI-U\fR] [\fI-V\fR]
+\fI\-L /path/to/list \-a john@doe.org \fR[\fI\-c\fR | \fI\-C\fR] \fR[\fI\-d\fR | \fI\-n\fR]
+[\fI\-h\fR] [\fI\-U\fR] [\fI\-V\fR]
.HP
\fB\-a\fR: Email address to subscribe
.HP
@@ -51,6 +51,6 @@
.SH AUTHORS
This manual page was written by the following persons:
.HP
-Søren Boll Overgaard <boll@debian.org> (based on html2man output)
+Søren Boll Overgaard <boll@debian.org> (based on html2man output)
.HP
-Mads Martin Jørgensen <mmj@mmj.dk>
+Mads Martin Jørgensen <mmj@mmj.dk>
diff -u -r -N a/man/mlmmj-unsub.1 b/man/mlmmj-unsub.1
--- a/man/mlmmj-unsub.1 2012-01-22 16:58:26.000000000 +0800
+++ b/man/mlmmj-unsub.1 2012-01-22 16:58:57.000000000 +0800
@@ -1,10 +1,10 @@
.TH mlmmj-unsub "1" "September 2004" mlmmj-unsub
.SH NAME
-mlmmj-unsub \- manual page for mlmmj-unsub
+mlmmj-unsub \- unsubscribe someone from a list
.SH SYNOPSIS
.B mlmmj-sub
-\fI-L /path/to/list -a john@doe.org \fR[\fI-c\fR | \fI-C\fR] [\fI-h\fR]
-\fR[\fI-d\fR | \fI-n\fR] [\fI-V\fR]
+\fI\-L /path/to/list \-a john@doe.org \fR[\fI\-c\fR | \fI\-C\fR] [\fI\-h\fR]
+\fR[\fI\-d\fR | \fI\-n\fR] [\fI\-V\fR]
.HP
\fB\-a\fR: Email address to unsubscribe
.HP
@@ -45,6 +45,6 @@
.SH AUTHORS
This manual page was written by the following persons:
.HP
-Søren Boll Overgaard <boll@debian.org> (based on html2man output)
+Søren Boll Overgaard <boll@debian.org> (based on html2man output)
.HP
-Mads Martin Jørgensen <mmj@mmj.dk>
+Mads Martin Jørgensen <mmj@mmj.dk>
next reply other threads:[~2012-01-22 9:08 UTC|newest]
Thread overview: 10+ messages / expand[flat|nested] mbox.gz Atom feed top
2012-01-22 9:08 Thomas Goirand [this message]
2012-01-22 13:56 ` [mlmmj] [patch] man page fixes Ben Schmidt
2012-01-22 19:13 ` Thomas Goirand
2012-01-23 0:37 ` Ben Schmidt
2012-01-23 2:06 ` Ben Schmidt
2012-01-23 7:11 ` Thomas Goirand
2012-01-23 16:39 ` Ben Schmidt
2012-01-24 6:17 ` Mads Martin Jørgensen
2012-01-27 4:47 ` Thomas Goirand
2012-01-27 5:37 ` Ben Schmidt
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=4F1BD224.40908@goirand.fr \
--to=thomas@goirand.fr \
--cc=mlmmj@mlmmj.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.