Bug#849036: xstow: lack of proofreading of xstow.ini.5 manual page
Package: xstow
Version: 1.0.0-2.1
Severity: normal
It appears that nobody bothered to proofread the xstow.ini.5 manual page.
The most obvious problem is that every occurrence of "traverse-links"
has been written as "traserve-links".
Here is a suggested revision of the introductory section to try and raise
the quality.
--------------------------------<snip>--------------------------------------
--- xstow.ini.5.orig 2014-02-13 11:35:45.000000000 +0000
+++ xstow.ini.5 2014-02-13 11:35:45.000000000 +0000
@@ -142,26 +142,25 @@
xstow.ini, config file for XStow
.SH "CONTENT"
.IX Header "CONTENT"
-The xstow.ini file contains some static informations about your
-system. It's possible setting most necessary values by setting the
-required command line option, but in some cases this won't make sense
-if you are using xstow quite often.
+The xstow.ini file contains some static informations about your system.
+It is possible to set most of the necessary values with command line options,
+but this will not be convenient if xstow is frequently used in this manner.
.SH "SYNTAX"
.IX Header "SYNTAX"
-The syntax of the configuration file is simple. It's the same as it is
+The syntax of the configuration file is simple. It is the same as that
used by \s-1KDE\s0 and \s-1GNOME.\s0
.PP
-The data is splitted into keys values and sections. The '#' sign marks
+The data is split into sections of keys and values. The '#' sign marks
a comment. Here is an example:
.PP
.Vb 3
-\& [traserve\-links]
+\& [traverse\-links]
\& keep\-targets = true
\& link = /usr/tmp # comment
.Ve
-.IP "\fB[traserve\-links]\fR" 4
-.IX Item "[traserve-links]"
-is a section with the name \*(L"traserve-links\*(R"
+.IP "\fB[traverse\-links]\fR" 4
+.IX Item "[traverse-links]"
+is a section with the name \*(L"traverse-links\*(R"
.IP "\fBkeep-targets = true\fR" 4
.IX Item "keep-targets = true"
is a key \- value pair, where 'keep\-targets' is the key and 'true' is
@@ -173,15 +172,15 @@
overwritten by the next config file. List keys like
\&\fB[traverse\-links]\fR=>\fBlink\fR will be appended to the list.
.PP
-If you wan't more informations about the current stow setup call XStow
+If you want more informations about the current stow setup, call XStow
like this:
.PP
.Vb 1
\& xstow \-s \-dl 1 dummy\-package | less
.Ve
.PP
-For getting information about which config files were processed you
-will have to set some environment values (see \fIxstow\fR\|(1) for
+To get information about which config files were processed, you
+need to set some environment values (see \fIxstow\fR\|(1) for
details).
Eg.:
.PP
@@ -190,8 +189,8 @@
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
-.SS "\s-1SECTION\s0 traserve-links"
-.IX Subsection "SECTION traserve-links"
+.SS "\s-1SECTION\s0 traverse-links"
+.IX Subsection "SECTION traverse-links"
In this section a number of links are listed, which xstow will
identify as links that are not part of an xstow managed package.
Eg.:
--------------------------------<snip>--------------------------------------
I would have included the patch as an attachment, but nmh complains -
whatnow: Cannot use attach commands with already-formatted MIME
message "/var/tmp/miller/reportbug-xstow-20161222-14401-P7VxaX"
-- System Information:
Debian Release: 8.6
APT prefers stable-updates
APT policy: (500, 'stable-updates'), (500, 'stable')
Architecture: armhf (armv7l)
Kernel: Linux 3.10.17.1-wand-armhf.com (SMP w/4 CPU cores)
Locale: LANG=en_US.UTF-8, LC_CTYPE=en_US.UTF-8 (charmap=ANSI_X3.4-1968) (ignored: LC_ALL set to C)
Shell: /bin/sh linked to /bin/dash
Init: systemd (via /run/systemd/system)
Versions of packages xstow depends on:
ii libc6 2.19-18+deb8u6
ii libgcc1 1:4.9.2-10
ii libstdc++6 4.9.2-10
xstow recommends no packages.
xstow suggests no packages.
-- no debconf information
Reply to: