summaryrefslogtreecommitdiffstats
path: root/usr.bin/soelim
diff options
context:
space:
mode:
authorbapt <bapt@FreeBSD.org>2015-11-07 01:58:23 +0000
committerbapt <bapt@FreeBSD.org>2015-11-07 01:58:23 +0000
commit65d73d8ca1a976c3b358a3978f0d4cafa5aee2a8 (patch)
treeb0991ca3af09f21e268d24b0d4f57123657cabc0 /usr.bin/soelim
parentca367cb477c85e5b6066c77de8c59963fca29ac1 (diff)
downloadFreeBSD-src-65d73d8ca1a976c3b358a3978f0d4cafa5aee2a8.zip
FreeBSD-src-65d73d8ca1a976c3b358a3978f0d4cafa5aee2a8.tar.gz
Improve soelim(1) manpages
Submitted by: Sascha Wildner <saw@online.de>
Diffstat (limited to 'usr.bin/soelim')
-rw-r--r--usr.bin/soelim/soelim.133
1 files changed, 19 insertions, 14 deletions
diff --git a/usr.bin/soelim/soelim.1 b/usr.bin/soelim/soelim.1
index 57e8614..1f4e5a83 100644
--- a/usr.bin/soelim/soelim.1
+++ b/usr.bin/soelim/soelim.1
@@ -24,7 +24,7 @@
.\"
.\" $FreeBSD$
.\"
-.Dd May 1, 2015
+.Dd November 7, 2015
.Dt SOELIM 1
.Os
.Sh NAME
@@ -34,43 +34,48 @@
.Nm
.Op Fl Crtv
.Op Fl I Ar dir
-.Op Ar files ...
+.Op Ar
.Sh DESCRIPTION
+The
.Nm
-reads
-.Ar files
-lines by lines.
+utility
+reads the specified files or the standard input and performs the textual
+inclusion implied by the
+.Xr nroff 1
+directives of the form:
.Pp
-If a line starts by:
+.Dl \&.so anotherfile
+.Pp
+If a line starts with:
.Dq .so anotherfile
-it replace the line by processing
+it replaces the line by processing
.Dq anotherfile .
Otherwise the line is printed to stdout.
.Bl -tag -width "-I dir"
.It Fl C
Recognise
.Em .so
-when not followed by a space character.
+when it is not followed by a space character.
.It Fl r
-Compatibility with GNU groff's
+Compatibility with groff's
.Xr soelim 1
(does nothing).
.It Fl t
-Compatibility with GNU groff's
+Compatibility with groff's
.Xr soelim 1
(does nothing).
.It Fl v
-Compatibility with GNU groff's
+Compatibility with groff's
.Xr soelim 1
(does nothing).
.It Fl I Ar dir
-This option specify directories where
+This option specifies directories where
.Nm
searches for files (both those on the command line and those named in
.Dq .so
directive.)
-This options may be specified multiple times. The directories will be searched
-in the order specified.
+This option may be specified multiple times.
+The directories will be searched in the order specified.
.El
.Pp
The files are always searched first in the current directory.
OpenPOWER on IntegriCloud