Updating web-site.

[mandoc.git] / manuals.7

diff --git a/manuals.7 b/manuals.7
index 318441ec76ec653a22b718c07413937341dc84df..f4fc9b090ae2a28923f84e66e62784c036da6ba0 100644 (file)
--- a/manuals.7
+++ b/manuals.7
@@ -1,4 +1,22 @@
-.Dd $Mdocdate: March 22 2009 $
+.\" $Id: manuals.7,v 1.9 2009/03/24 10:59:50 kristaps Exp $
+.\"
+.\" Copyright (c) 2009 Kristaps Dzonsons <kristaps@openbsd.org>
+.\"
+.\" Permission to use, copy, modify, and distribute this software for any
+.\" purpose with or without fee is hereby granted, provided that the
+.\" above copyright notice and this permission notice appear in all
+.\" copies.
+.\"
+.\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL
+.\" WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED
+.\" WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE
+.\" AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL
+.\" DAMAGES OR ANY DAMAGES 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: March 24 2009 $

 .Dt manuals 7
 .Os
 .\" SECTION
 .Dt manuals 7
 .Os
 .\" SECTION


@@ -29,6 +47,8 @@ format or directory structure or device driver, it needs documentation.
 Prepare your composition environment by copying over the manual template
 from 
 .Pa /usr/share/misc/mdoc.template .
 Prepare your composition environment by copying over the manual template
 from 
 .Pa /usr/share/misc/mdoc.template .

+.Pp
+If this file doesn't exist, bug your administrator.

 .Em \&Do not
 start afresh or by copying another manual unless you know exactly what
 you're doing!
 .Em \&Do not
 start afresh or by copying another manual unless you know exactly what
 you're doing!


@@ -98,11 +118,8 @@ formatting language.
 .Pp
 There exist other documentation-specific languages, such as the
 historical
 .Pp
 There exist other documentation-specific languages, such as the
 historical

-.Xr me 7 ,
-.Xr ms 7
-and

 .Xr man 7
 .Xr man 7

-packages of 
+package of 

 .Xr roff 7 ;
 newer languages such as DocBook, texinfo or schema-driven XML; or even
 ad-hoc conventions such as README files.  
 .Xr roff 7 ;
 newer languages such as DocBook, texinfo or schema-driven XML; or even
 ad-hoc conventions such as README files.  


@@ -143,7 +160,12 @@ or, if not available,
 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
 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: March 22 2009 $
+.Dl \&.Dd $Mdocdate: March 24 2009 $
+.Pp
+If using version control, the first line in your manual should be a
+comment with the 
+.Li $Id: manuals.7,v 1.9 2009/03/24 10:59:50 kristaps Exp $
+rcs tag.

 .\" SUBSECTION
 .Ss Viewing
 mdoc documents may be paged to your terminal with traditional 
 .\" SUBSECTION
 .Ss Viewing
 mdoc documents may be paged to your terminal with traditional 


@@ -182,6 +204,10 @@ output:
 \&.1.txt:
        mandoc -Tascii $< | col -b >$@
 .Ed
 \&.1.txt:
        mandoc -Tascii $< | col -b >$@
 .Ed

+.\" SUBSECTION
+.Ss Licensing
+Your manual must have a license.  It should be listed at the start of
+your document, just as in source code.

 .\" SECTION
 .Sh BEST PRACTICES
 The
 .\" SECTION
 .Sh BEST PRACTICES
 The


@@ -211,6 +237,17 @@ symbols and so on), use the escapes dictated in
 .Xr mdoc 7 .
 .El
 .\" SUBSECTION
 .Xr mdoc 7 .
 .El
 .\" SUBSECTION

+.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 
+.Sq \&Oo/Oc .
+.Em \&Do not
+use 
+.Sq \&Xo/Xc ;
+instead, either fine another way to write long lines, or, at the
+absolute worst, use CPP-style newline escapes.
+.\" SUBSECTION

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