summaryrefslogtreecommitdiff
path: root/usr.bin/mandoc/manuals.7
diff options
context:
space:
mode:
authorIngo Schwarze <schwarze@cvs.openbsd.org>2009-08-22 16:32:23 +0000
committerIngo Schwarze <schwarze@cvs.openbsd.org>2009-08-22 16:32:23 +0000
commite61c081b721f2875bc39b6b22ddbc4c07cc7caa7 (patch)
tree773be9b606cc88095e68293ac44560ec7510c65b /usr.bin/mandoc/manuals.7
parent16285420c1f0af9beb32407609a78bc4c3f30bdb (diff)
sync to 1.8.5: add "vim -q" tip (from uqs at spoerlein dot net)
Diffstat (limited to 'usr.bin/mandoc/manuals.7')
-rw-r--r--usr.bin/mandoc/manuals.717
1 files changed, 13 insertions, 4 deletions
diff --git a/usr.bin/mandoc/manuals.7 b/usr.bin/mandoc/manuals.7
index a7d309ce1be..7fb6b53223f 100644
--- a/usr.bin/mandoc/manuals.7
+++ b/usr.bin/mandoc/manuals.7
@@ -1,4 +1,4 @@
-.\" $Id: manuals.7,v 1.4 2009/07/26 00:56:53 schwarze Exp $
+.\" $Id: manuals.7,v 1.5 2009/08/22 16:32:22 schwarze Exp $
.\"
.\" Copyright (c) 2009 Kristaps Dzonsons <kristaps@kth.se>
.\"
@@ -14,7 +14,7 @@
.\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
.\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
.\"
-.Dd $Mdocdate: July 26 2009 $
+.Dd $Mdocdate: August 22 2009 $
.Dt MANUALS 7
.Os
.\" SECTION
@@ -106,7 +106,16 @@ for this document. Rename the template file:
.Ss Development Tools
While writing, make sure that your manual is correctly structured:
.Pp
-.Dl % mandoc \-Tlint \-Wall name.1
+.Dl % mandoc \-Tlint \-Wall \-fstrict name.1
+.Pp
+The quick-fix feature of
+.Xr vim 1
+is useful for checking over many manuals:
+.Bd -literal -offset indent
+% mandoc \-Wall \-fstrict \-Tlint \-fign-errors \e
+ ./path/to/manuals/* 2>&1 > /tmp/mandoc.errs
+% vim -q /tmp/mandoc.errs
+.Ed
.Pp
You may spell-check your work as follows:
.Pp
@@ -125,7 +134,7 @@ or
to version-control your work. If you wish the last check-in to effect
your document's date, use the following RCS tag for the date macro:
.Pp
-.Dl \&.Dd $Mdocdate: July 26 2009 $
+.Dl \&.Dd $Mdocdate: August 22 2009 $
.\" SUBSECTION
.Ss Viewing
mdoc documents may be paged to your terminal with