os/doc
3
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

Add 2017Q3 man page entry from wblock

Browse source
This commit is contained in:
Benjamin Kaduk 2017-12-10 04:02:26 +00:00
parent 1582552349
commit 66d80d1e27
Notes: svn2git 2020-12-08 03:00:23 +00:00 
svn path=/head/; revision=51273
1 changed files with 52 additions and 0 deletions

52
en_US.ISO8859-1/htdocs/news/status/report-2017-07-2017-09.xml
View file

@ -1224,4 +1224,56 @@
</task>
</help>
</project>
<project cat='doc'>
<title>Manual Pages</title>
<contact>
<person>
<name>
<given>Warren</given>
<common>Block</common>
<email>wblock@FreeBSD.org</email>
</name>
</person>
</contact>
<links>
<url href="https://www.freebsd.org/doc/en_US.ISO8859-1/books/fdp-primer/">&os; Documentation Project Primer</url>
</links>
<body>
<p>Over the last year, interest has increased in manual pages, in
large part due to excellent infrastructure work by Baptiste
Daroussin and others, and promotion by George Neville-Neil and
others. This increased interest has been both gratifying and
problematic. Our man pages are underappreciated gems, but we
have sadly lacked any substantial documentation on how to write
new ones.</p>
<p>In September, I added a new chapter to the
<a href="https://www.freebsd.org/doc/en_US.ISO8859-1/books/fdp-primer/">&os;Documentation
Project Primer</a> describing the basics of creating a man
page. It includes descriptions of the markup, section
structure, recommended optional material such as examples,
and sample templates for the most common types of man pages.
The Resources section includes links to several external
resources, including the excellent <a
href="http://manpages.bsd.lv/mdoc.html">Practical UNIX
Manuals: mdoc</a>.</p>
<p>While this chapter is not a full tutorial, it does begin to fill
in a large gap in our documentation resources and provide a
starting point from which to grow.</p>
</body>
<help>
<task>Add more explanation and examples of markup.</task>
<task>Expand the sample templates with additional desired standard
features, like an EXAMPLES section.</task>
<task>Add more sample templates.</task>
</help>
</project>
</report>