Date: Mon, 12 Apr 2010 12:34:48 +0300 From: Giorgos Keramidas <keramida@ceid.upatras.gr> To: Fbsd1 <fbsd1@a1poweruser.com> Cc: FreeBSD Questions <freebsd-questions@freebsd.org> Subject: Re: How to make "man" pages Message-ID: <871velko93.fsf@kobe.laptop> In-Reply-To: <4BC2DE80.8090209@a1poweruser.com> (fbsd1@a1poweruser.com's message of "Mon, 12 Apr 2010 16:49:04 %2B0800") References: <4BB2BABF.9070401@a1poweruser.com> <4BB2F8FF.7090707@infracaninophile.co.uk> <4BB2FFB1.4020500@a1poweruser.com> <87wrwswjeo.fsf@kobe.laptop> <4BC2DE80.8090209@a1poweruser.com>
next in thread | previous in thread | raw e-mail | index | archive | help
On Mon, 12 Apr 2010 16:49:04 +0800, Fbsd1 <fbsd1@a1poweruser.com> wrote: > For the questions list archives: > I wrote an How To Creating a manpage from scratch. > > You can read it here. > > http://www.daemonforums.org/showthread.php?t=4602 > > Thanks to all the people who replied to my post. Nice post. This is exactly the sort of post that raises the signal to noise ratio in web-based forums. Good job writing it :-) You should probably try to grok some of the semantic markup requests like .Op too though. For example this part: : SYNOPSIS : jail [-dhi] [-J jid_file] [-l -u username | -U username] [-c | -m] : jail [-hi] [-n jailname] [-J jid_file] [-s securelevel] : [-l -u username | -U username] [path hostname [ip[,..]] Is commonly written in several lines. If you try to read each line separately they do make sense, e.g.: .Nm .Op Fl dhi Will render as: jail [-dhl] with the flag letters displayed in bold text. The .Op macro wraps everything in [...] brackets. The .Fl macro marks up 'command flags'. It takes a bit of practice to write manpages using this sort of markup, but the displayed output looks great in ascii, PostScript or HTML output modes. So it's worth trying to learn more about it.
Want to link to this message? Use this URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?871velko93.fsf>