Bug 145644

Summary: Add artical about creating manpage from scratch
Product: Documentation Reporter: Joe <fbsd1>
Component: DocumentationAssignee: freebsd-doc mailing list <doc>
Status: Closed Overcome By Events    
Severity: Affects Only Me CC: bcr
Priority: Normal    
Version: Latest   
Hardware: Any   
OS: Any   
Attachments:
Description Flags
file.txt none

Description Joe 2010-04-12 10:40:01 UTC
The FreeBSD documentation environment is lacking instructions on how to
create man page manuals.  I have written a How To document titled; 
Creating a manpage from scratch. Its too big for the FAQ list, 
but fits nicely into the article size.
 
You can read it online at 
http://www.daemonforums.org/showthread.php?t=4602 

I am donating it to the FreeBSD document team with the hopes you will take  
the text file I have attached and convert it to SGML and add it as an article.

Fix: Patch attached with submission follows:
Comment 1 Niclas Zeising 2011-05-24 10:44:04 UTC
Hi!
I'll work on converting this to SGML.
Regards!
-- 
Niclas
Comment 2 Niclas Zeising 2012-06-15 22:05:00 UTC
Just to submit a status report...
I'm still working on this.  I had to take a break because of the 
workload elsewhere, but I'll continue working on it during the summer.
Regards!
-- 
Niclas Zeising
Comment 3 Niclas Zeising freebsd_committer 2012-07-18 11:35:34 UTC
Responsible Changed
From-To: freebsd-doc->zeising

I'm still working on this.
Comment 4 Doug Barton freebsd_committer 2012-07-18 12:17:11 UTC
This article should mention /usr/share/examples/mdoc/

hth,

Doug

-- 

    Change is hard.
Comment 5 joeb1 2013-01-13 19:49:40 UTC
Has there been any progress to date?

I submitted this PR. 
Had to change email address because of to much spam.
Comment 6 Eitan Adler freebsd_committer freebsd_triage 2017-12-31 07:58:45 UTC
For bugs matching the following criteria:

Status: In Progress Changed: (is less than) 2014-06-01

Reset to default assignee and clear in-progress tags.

Mail being skipped
Comment 7 Benedict Reuschling freebsd_committer 2019-06-08 09:13:01 UTC
We have a chapter about how to write man pages on the FDP primer for a good while now:

https://www.freebsd.org/doc/en_US.ISO8859-1/books/fdp-primer/manpages.html

It contains pretty much everything that is in the submitted file.txt, so I think closing this PR is reasonable. If you find that there is something missing, please open a new PR.