fix an obvious typo in print_bvspace():

[mandoc.git] / manuals.7

diff --git a/manuals.7 b/manuals.7
index aba6d7f232daaac8c20ce78ce9a035af633b0093..ac975e19bc3d2f792d549ddeba61f09b79086182 100644 (file)
--- a/manuals.7
+++ b/manuals.7
@@ -1,6 +1,6 @@
-.\"    $Id: manuals.7,v 1.16 2009/07/16 22:16:44 kristaps Exp $
+.\"    $Id: manuals.7,v 1.20 2010/04/13 05:26:49 kristaps Exp $

 .\"
 .\"

-.\" Copyright (c) 2009 Kristaps Dzonsons <kristaps@kth.se>
+.\" Copyright (c) 2009 Kristaps Dzonsons <kristaps@bsd.lv>

 .\"
 .\" Permission to use, copy, modify, and distribute this software for any
 .\" purpose with or without fee is hereby granted, provided that the above
 .\"
 .\" Permission to use, copy, modify, and distribute this software for any
 .\" purpose with or without fee is hereby granted, provided that the above


@@ -13,8 +13,8 @@
 .\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
 .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
 .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
 .\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
 .\" 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 16 2009 $
+.\"
+.Dd $Mdocdate: April 13 2010 $

 .Dt MANUALS 7
 .Os
 .\" SECTION
 .Dt MANUALS 7
 .Os
 .\" SECTION


@@ -28,15 +28,15 @@
 .Pp
 A system component's documentation describes the utility of that
 component, whether it's a device driver, an executable or, most
 .Pp
 A system component's documentation describes the utility of that
 component, whether it's a device driver, an executable or, most

-importantly, a game.  
+importantly, a game.

 .Pp
 .Pp

-This document serves as a tutorial to writing 
-.Ux 
+This document serves as a tutorial to writing
+.Ux

 documentation
 .Pq Dq manuals .
 .\" SECTION
 .Sh ENVIRONMENT
 documentation
 .Pq Dq manuals .
 .\" SECTION
 .Sh ENVIRONMENT

-First, copy over the manual template from 
+First, copy over the manual template from

 .Pa /usr/share/misc/mdoc.template
 into your source directory.
 .Pp
 .Pa /usr/share/misc/mdoc.template
 into your source directory.
 .Pp


@@ -66,7 +66,7 @@ file and wire protocol formats
 games
 .It 7
 tutorials, documents and papers
 games
 .It 7
 tutorials, documents and papers

-.It 8 
+.It 8

 administrator utilities
 .It 9
 in-kernel routines
 administrator utilities
 .It 9
 in-kernel routines


@@ -95,7 +95,7 @@ other manuals by that same name before committing:
 .Pp
 .Dl % apropos myname
 .Pp
 .Pp
 .Dl % apropos myname
 .Pp

-Manual files are named 
+Manual files are named

 .Pa myname.mysection ,
 such as
 .Pa manuals.7
 .Pa myname.mysection ,
 such as
 .Pa manuals.7


@@ -106,29 +106,38 @@ for this document.  Rename the template file:
 .Ss Development Tools
 While writing, make sure that your manual is correctly structured:
 .Pp
 .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
 .Dl % deroff name.1 | spell
 .Pp
 .Pp
 You may spell-check your work as follows:
 .Pp
 .Dl % deroff name.1 | spell
 .Pp

-If 
+If

 .Xr ispell 1
 is installed, it has a special mode for manuals:
 .Pp
 .Dl % ispell \-n name.1
 .Pp
 .Xr ispell 1
 is installed, it has a special mode for manuals:
 .Pp
 .Dl % ispell \-n name.1
 .Pp

-Use 
+Use

 .Xr cvs 1
 or
 .Xr rcs 1
 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
 .Xr cvs 1
 or
 .Xr rcs 1
 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 16 2009 $
+.Dl \&.Dd $Mdocdate: April 13 2010 $

 .\" SUBSECTION
 .Ss Viewing
 .\" SUBSECTION
 .Ss Viewing

-mdoc documents may be paged to your terminal with 
+mdoc documents may be paged to your terminal with

 .Xr mandoc 1 .
 If you plan on distributing your work to systems without this tool,
 check it against
 .Xr mandoc 1 .
 If you plan on distributing your work to systems without this tool,
 check it against


@@ -139,7 +148,7 @@ check it against
 .Ed
 .\" SUBSECTION
 .Ss Automation
 .Ed
 .\" SUBSECTION
 .Ss Automation

-Consider adding your mdoc documents to 
+Consider adding your mdoc documents to

 .Xr make 1
 Makefiles in order to automatically check your input:
 .Bd -literal -offset indent
 .Xr make 1
 Makefiles in order to automatically check your input:
 .Bd -literal -offset indent


@@ -155,8 +164,8 @@ Your manual must have a license.  It should be listed at the start of
 your document, just as in source code.
 .\" SECTION
 .Sh COMPOSITION
 your document, just as in source code.
 .\" SECTION
 .Sh COMPOSITION

-Manuals should 
-.Em always 
+Manuals should
+.Em always

 be written in the
 .Xr mdoc 7
 formatting language.
 be written in the
 .Xr mdoc 7
 formatting language.


@@ -167,7 +176,7 @@ Open the template you've copied into
 and begin editing.
 .\" SUBSECTION
 .Ss Language
 and begin editing.
 .\" SUBSECTION
 .Ss Language

-.Bl -enum 
+.Bl -enum

 .It
 Use clear, concise language.  Favour simplicity.
 .It
 .It
 Use clear, concise language.  Favour simplicity.
 .It


@@ -187,15 +196,15 @@ symbols and so on), use the escapes dictated in
 .Ss Style
 The structure of the mdoc language makes it very hard to have any
 particular format style.  Keep your lines under 72 characters in length.
 .Ss Style
 The structure of the mdoc language makes it very hard to have any
 particular format style.  Keep your lines under 72 characters in length.

-If you must have long option lines, use 
+If you must have long option lines, use

 .Sq \&Oo/Oc .
 The same goes for function prototypes.
 .Em \&Do not
 .Sq \&Oo/Oc .
 The same goes for function prototypes.
 .Em \&Do not

-use 
+use

 .Sq \&Xo/Xc .
 Find another way to structure your line.
 .\" SUBSECTION
 .Sq \&Xo/Xc .
 Find another way to structure your line.
 .\" SUBSECTION

-.Ss References 
+.Ss References

 Other components may be referenced with the
 .Sq \&Xr
 and
 Other components may be referenced with the
 .Sq \&Xr
 and