shaba/lvm2
1
0
Fork 0
mirror of git://sourceware.org/git/lvm2.git synced 2024-12-21 13:34:40 +03:00
Code Releases Activity
cfcbf89ed0
lvm2/man/cmirrord.8_main

47 lines
1.2 KiB
Plaintext
Raw Normal View History

And more fixes for cmirror build.
2010-01-19 05:04:33 +03:00
.TH CMIRRORD 8 "LVM TOOLS #VERSION#" "Red Hat Inc" \" -*- nroff -*-
man: typography With to use .TP where it's easy and doesn't change layout (since .HP is marked as deprecated) - but .TP is not always perfetc match. Avoid submitting empty lines to troff and replace them mostly with .P and use '.' at line start to preserve 'visual' presence of empty line while editing man page manually when there is no extra space needed. Fix some markup. Add some missing SEE ALSO section. Drop some white-space at end-of-lines. Improve hyphenation logic so we do not split options. Use '.IP numbers' only with first one the row (others in row automatically derive this value) Use automatic enumeration for .SH titles. Guidelines in-use: https://man7.org/linux/man-pages/man7/groff.7.html https://www.gnu.org/software/groff/manual/html_node/Man-usage.html https://www.gnu.org/software/groff/manual/html_node/Lists-in-ms.html
2021-04-13 16:26:54 +03:00
.
And more fixes for cmirror build.
2010-01-19 05:04:33 +03:00
.SH NAME
man: typography With to use .TP where it's easy and doesn't change layout (since .HP is marked as deprecated) - but .TP is not always perfetc match. Avoid submitting empty lines to troff and replace them mostly with .P and use '.' at line start to preserve 'visual' presence of empty line while editing man page manually when there is no extra space needed. Fix some markup. Add some missing SEE ALSO section. Drop some white-space at end-of-lines. Improve hyphenation logic so we do not split options. Use '.IP numbers' only with first one the row (others in row automatically derive this value) Use automatic enumeration for .SH titles. Guidelines in-use: https://man7.org/linux/man-pages/man7/groff.7.html https://www.gnu.org/software/groff/manual/html_node/Man-usage.html https://www.gnu.org/software/groff/manual/html_node/Lists-in-ms.html
2021-04-13 16:26:54 +03:00
.
man: properly escape - Dash should be using '\' to be typographically correct.
2014-06-11 13:06:30 +04:00
cmirrord \(em cluster mirror log daemon
man: typography With to use .TP where it's easy and doesn't change layout (since .HP is marked as deprecated) - but .TP is not always perfetc match. Avoid submitting empty lines to troff and replace them mostly with .P and use '.' at line start to preserve 'visual' presence of empty line while editing man page manually when there is no extra space needed. Fix some markup. Add some missing SEE ALSO section. Drop some white-space at end-of-lines. Improve hyphenation logic so we do not split options. Use '.IP numbers' only with first one the row (others in row automatically derive this value) Use automatic enumeration for .SH titles. Guidelines in-use: https://man7.org/linux/man-pages/man7/groff.7.html https://www.gnu.org/software/groff/manual/html_node/Man-usage.html https://www.gnu.org/software/groff/manual/html_node/Lists-in-ms.html
2021-04-13 16:26:54 +03:00
.
And more fixes for cmirror build.
2010-01-19 05:04:33 +03:00
.SH SYNOPSIS
man: typography With to use .TP where it's easy and doesn't change layout (since .HP is marked as deprecated) - but .TP is not always perfetc match. Avoid submitting empty lines to troff and replace them mostly with .P and use '.' at line start to preserve 'visual' presence of empty line while editing man page manually when there is no extra space needed. Fix some markup. Add some missing SEE ALSO section. Drop some white-space at end-of-lines. Improve hyphenation logic so we do not split options. Use '.IP numbers' only with first one the row (others in row automatically derive this value) Use automatic enumeration for .SH titles. Guidelines in-use: https://man7.org/linux/man-pages/man7/groff.7.html https://www.gnu.org/software/groff/manual/html_node/Man-usage.html https://www.gnu.org/software/groff/manual/html_node/Lists-in-ms.html
2021-04-13 16:26:54 +03:00
.
.B cmirrord
.RB [ -f | --foreground ]
.RB [ -h | --help ]
.
Fill in a little more on the man page for cmirrord
2010-01-20 18:17:25 +03:00
.SH DESCRIPTION
man: typography With to use .TP where it's easy and doesn't change layout (since .HP is marked as deprecated) - but .TP is not always perfetc match. Avoid submitting empty lines to troff and replace them mostly with .P and use '.' at line start to preserve 'visual' presence of empty line while editing man page manually when there is no extra space needed. Fix some markup. Add some missing SEE ALSO section. Drop some white-space at end-of-lines. Improve hyphenation logic so we do not split options. Use '.IP numbers' only with first one the row (others in row automatically derive this value) Use automatic enumeration for .SH titles. Guidelines in-use: https://man7.org/linux/man-pages/man7/groff.7.html https://www.gnu.org/software/groff/manual/html_node/Man-usage.html https://www.gnu.org/software/groff/manual/html_node/Lists-in-ms.html
2021-04-13 16:26:54 +03:00
.
man: improve cmirrord.8 manpage - Keywords in bold - Add syslog and signal ref. - Sort see also sections Signed-off-by: Stéphane Aulery <saulery@free.fr>
2014-11-27 04:32:38 +03:00
\fBcmirrord\fP is the daemon that tracks mirror log information in a cluster.
man-generator/man/help: simplify hyphen escaping Commits a29bb6a14b5e920092495fb9a1623e527d22daac ... 5c199d99f4dc9911d62673baba7643ea649ffe64 narrowed down on addressing the escaping of hyphens in the dynamic creation of manuals whilst avoiding them in creating help texts. This lead to a sequence of slipping through hyphens adrressed by additional patches in aforementioned commit series. On the other hand, postprocessing dynamically man-generator created and statically provided manuals catches all hyphens in need of escaping. Changes: - revert the above commits whilst keeping man-generator streamlining and the detection of any '\' when generating help texts in order to avoid escapes to slip in - Dynamically escape hyphens in manaual pages using sed(1) in the respective Makefile targets - remove any manually added escaping on hyphens from any static manual sources or headers
2017-03-27 17:45:48 +03:00
It is specific to device-mapper based mirrors (and by extension, LVM
a little more information for the cmirrord man page
2010-01-23 00:48:17 +03:00
cluster mirrors). Cluster mirrors are not possible without this daemon
running.
man: typography With to use .TP where it's easy and doesn't change layout (since .HP is marked as deprecated) - but .TP is not always perfetc match. Avoid submitting empty lines to troff and replace them mostly with .P and use '.' at line start to preserve 'visual' presence of empty line while editing man page manually when there is no extra space needed. Fix some markup. Add some missing SEE ALSO section. Drop some white-space at end-of-lines. Improve hyphenation logic so we do not split options. Use '.IP numbers' only with first one the row (others in row automatically derive this value) Use automatic enumeration for .SH titles. Guidelines in-use: https://man7.org/linux/man-pages/man7/groff.7.html https://www.gnu.org/software/groff/manual/html_node/Man-usage.html https://www.gnu.org/software/groff/manual/html_node/Lists-in-ms.html
2021-04-13 16:26:54 +03:00
.P
man: remove some clvmd references
2018-11-14 19:00:23 +03:00
This daemon relies on the cluster infrastructure provided by the corosync,
which must be set up and running in order for cmirrord to function.
man: typography With to use .TP where it's easy and doesn't change layout (since .HP is marked as deprecated) - but .TP is not always perfetc match. Avoid submitting empty lines to troff and replace them mostly with .P and use '.' at line start to preserve 'visual' presence of empty line while editing man page manually when there is no extra space needed. Fix some markup. Add some missing SEE ALSO section. Drop some white-space at end-of-lines. Improve hyphenation logic so we do not split options. Use '.IP numbers' only with first one the row (others in row automatically derive this value) Use automatic enumeration for .SH titles. Guidelines in-use: https://man7.org/linux/man-pages/man7/groff.7.html https://www.gnu.org/software/groff/manual/html_node/Man-usage.html https://www.gnu.org/software/groff/manual/html_node/Lists-in-ms.html
2021-04-13 16:26:54 +03:00
.P
man: improve cmirrord.8 manpage - Keywords in bold - Add syslog and signal ref. - Sort see also sections Signed-off-by: Stéphane Aulery <saulery@free.fr>
2014-11-27 04:32:38 +03:00
Output is logged via \fBsyslog\fP(3). The \fBSIGUSR1 signal\fP(7) can be
issued to \fBcmirrord\fP to gather current status information for debugging
purposes.
man: typography With to use .TP where it's easy and doesn't change layout (since .HP is marked as deprecated) - but .TP is not always perfetc match. Avoid submitting empty lines to troff and replace them mostly with .P and use '.' at line start to preserve 'visual' presence of empty line while editing man page manually when there is no extra space needed. Fix some markup. Add some missing SEE ALSO section. Drop some white-space at end-of-lines. Improve hyphenation logic so we do not split options. Use '.IP numbers' only with first one the row (others in row automatically derive this value) Use automatic enumeration for .SH titles. Guidelines in-use: https://man7.org/linux/man-pages/man7/groff.7.html https://www.gnu.org/software/groff/manual/html_node/Man-usage.html https://www.gnu.org/software/groff/manual/html_node/Lists-in-ms.html
2021-04-13 16:26:54 +03:00
.P
man: improve cmirrord.8 manpage - Keywords in bold - Add syslog and signal ref. - Sort see also sections Signed-off-by: Stéphane Aulery <saulery@free.fr>
2014-11-27 04:32:38 +03:00
Once started, \fBcmirrord\fP will run until it is shutdown via \fBSIGINT\fP
signal. If there are still active cluster mirrors, however, the signal will be
ignored. Active cluster mirrors should be shutdown before stopping the cluster
mirror log daemon.
man: typography With to use .TP where it's easy and doesn't change layout (since .HP is marked as deprecated) - but .TP is not always perfetc match. Avoid submitting empty lines to troff and replace them mostly with .P and use '.' at line start to preserve 'visual' presence of empty line while editing man page manually when there is no extra space needed. Fix some markup. Add some missing SEE ALSO section. Drop some white-space at end-of-lines. Improve hyphenation logic so we do not split options. Use '.IP numbers' only with first one the row (others in row automatically derive this value) Use automatic enumeration for .SH titles. Guidelines in-use: https://man7.org/linux/man-pages/man7/groff.7.html https://www.gnu.org/software/groff/manual/html_node/Man-usage.html https://www.gnu.org/software/groff/manual/html_node/Lists-in-ms.html
2021-04-13 16:26:54 +03:00
.
cmirrord manual: add --foreground and --help options
2015-07-08 15:41:24 +03:00
.SH OPTIONS
man: typography With to use .TP where it's easy and doesn't change layout (since .HP is marked as deprecated) - but .TP is not always perfetc match. Avoid submitting empty lines to troff and replace them mostly with .P and use '.' at line start to preserve 'visual' presence of empty line while editing man page manually when there is no extra space needed. Fix some markup. Add some missing SEE ALSO section. Drop some white-space at end-of-lines. Improve hyphenation logic so we do not split options. Use '.IP numbers' only with first one the row (others in row automatically derive this value) Use automatic enumeration for .SH titles. Guidelines in-use: https://man7.org/linux/man-pages/man7/groff.7.html https://www.gnu.org/software/groff/manual/html_node/Man-usage.html https://www.gnu.org/software/groff/manual/html_node/Lists-in-ms.html
2021-04-13 16:26:54 +03:00
.
.TP
.BR -f | --foreground
cmirrord manual: add --foreground and --help options
2015-07-08 15:41:24 +03:00
Do not fork and log to the terminal.
man: typography With to use .TP where it's easy and doesn't change layout (since .HP is marked as deprecated) - but .TP is not always perfetc match. Avoid submitting empty lines to troff and replace them mostly with .P and use '.' at line start to preserve 'visual' presence of empty line while editing man page manually when there is no extra space needed. Fix some markup. Add some missing SEE ALSO section. Drop some white-space at end-of-lines. Improve hyphenation logic so we do not split options. Use '.IP numbers' only with first one the row (others in row automatically derive this value) Use automatic enumeration for .SH titles. Guidelines in-use: https://man7.org/linux/man-pages/man7/groff.7.html https://www.gnu.org/software/groff/manual/html_node/Man-usage.html https://www.gnu.org/software/groff/manual/html_node/Lists-in-ms.html
2021-04-13 16:26:54 +03:00
.TP
.BR -h | --help
cmirrord manual: add --foreground and --help options
2015-07-08 15:41:24 +03:00
Print usage.
man: typography With to use .TP where it's easy and doesn't change layout (since .HP is marked as deprecated) - but .TP is not always perfetc match. Avoid submitting empty lines to troff and replace them mostly with .P and use '.' at line start to preserve 'visual' presence of empty line while editing man page manually when there is no extra space needed. Fix some markup. Add some missing SEE ALSO section. Drop some white-space at end-of-lines. Improve hyphenation logic so we do not split options. Use '.IP numbers' only with first one the row (others in row automatically derive this value) Use automatic enumeration for .SH titles. Guidelines in-use: https://man7.org/linux/man-pages/man7/groff.7.html https://www.gnu.org/software/groff/manual/html_node/Man-usage.html https://www.gnu.org/software/groff/manual/html_node/Lists-in-ms.html
2021-04-13 16:26:54 +03:00
.
Fill in a little more on the man page for cmirrord
2010-01-20 18:17:25 +03:00
.SH SEE ALSO
man: typography With to use .TP where it's easy and doesn't change layout (since .HP is marked as deprecated) - but .TP is not always perfetc match. Avoid submitting empty lines to troff and replace them mostly with .P and use '.' at line start to preserve 'visual' presence of empty line while editing man page manually when there is no extra space needed. Fix some markup. Add some missing SEE ALSO section. Drop some white-space at end-of-lines. Improve hyphenation logic so we do not split options. Use '.IP numbers' only with first one the row (others in row automatically derive this value) Use automatic enumeration for .SH titles. Guidelines in-use: https://man7.org/linux/man-pages/man7/groff.7.html https://www.gnu.org/software/groff/manual/html_node/Man-usage.html https://www.gnu.org/software/groff/manual/html_node/Lists-in-ms.html
2021-04-13 16:26:54 +03:00
.
man: remove some clvmd references
2018-11-14 19:00:23 +03:00
.BR lvmlockd (8),
.BR lvm (8),
man: improve cmirrord.8 manpage - Keywords in bold - Add syslog and signal ref. - Sort see also sections Signed-off-by: Stéphane Aulery <saulery@free.fr>
2014-11-27 04:32:38 +03:00
.BR syslog (3),
man: remove some clvmd references
2018-11-14 19:00:23 +03:00
.BR signal (7)
Copy Permalink