Date: Sat, 11 Sep 2010 09:09:30 -0700 From: Chip Camden <sterling@camdensoftware.com> To: freebsd-ports@freebsd.org Subject: Re: man page style questions Message-ID: <20100911160930.GB3214@libertas.local.camdensoftware.com> In-Reply-To: <4C8B4324.90505@executive-computing.de> References: <4C8B4324.90505@executive-computing.de>
next in thread | previous in thread | raw e-mail | index | archive | help
--tsOsTdHNUZQcU9Ye Content-Type: text/plain; charset=us-ascii Content-Disposition: inline Content-Transfer-Encoding: quoted-printable Quoth Marco Steinbach on Saturday, 11 September 2010: > I'm reposting this to -ports, as I got no replies on -doc within several= =20 > days. >=20 >=20 > I'm currently preparing a man page for a yet to be submited new port, > and altough I was able to get answers for some of my questions from the > mdoc(7) man page and other sources, there are still some areas where I > am not sure about how to properly format and label things. >=20 > The current source of the man page is available at > http://www.moehre.org/files/sqtop/sqtop.1 >=20 > The port has an optional ncurses-based interface, which, if used, allows > the behaviour of the utility to be changed by pressing certain keys. >=20 > - Is "INTERACTIVE MODE" the appropiate term to be used as heading for > the section dealing with the specifics of a ncurses-based user interface ? >=20 > - What labels are to be used for keys which usually do not produce a > printable character ? E.g. is the <return>-key to be represented as > "return", "<return>" or "RETURN" (or is it to be named "enter", anyway ?) >=20 > - What about the cursor movement and other directional keys like > <cursor-left/right/up/down>, <pageup/down>, <home/end> ? >=20 > - Are there any preferences for the macros to use for keys to be > pressed, e.g. is the following acceptable: > .Bl -tag -width Fl > .It Ic C > Do the C thing. > .It Ic A > Do the A thing. > .El >=20 >=20 > Any hints and suggestions (wording, macro usage, etc) to make the man > page a better fit to the style of the FreeBSD project are greatly > appreciated. >=20 > MfG CoCo >=20 > _______________________________________________ > freebsd-ports@freebsd.org mailing list > http://lists.freebsd.org/mailman/listinfo/freebsd-ports > To unsubscribe, send any mail to "freebsd-ports-unsubscribe@freebsd.org" I'm glad you asked this question. I don't have any answers, but I am eagerly awaiting some authoritative replies. AFAIK, we're lacking in guidelines here. --=20 Sterling (Chip) Camden | sterling@camdensoftware.com | 2048D/3A978E4F http://camdensoftware.com | http://chipstips.com | http://chipsquips= .com --tsOsTdHNUZQcU9Ye Content-Type: application/pgp-signature Content-Disposition: inline -----BEGIN PGP SIGNATURE----- Version: GnuPG v1.4.10 (FreeBSD) iQEcBAEBAgAGBQJMi6m6AAoJEIpckszW26+RwmYH/2TaWUx5T8oHeMZXAJypKXzc UknMUxSeao2unCAobe2FBChl0ArOwaNW7ra9WWsVqAoduKBSYbGf1rAHYq+8PZIb sy0OthA9fA2Q15DIvSmeeV9l1V+7Txs38FUDyzgRLltIRZpqM3WMpOXsYsHg2Jf0 9WkwYFcEYYW5qykw4IhOnApWTN5Ur/UvAKcgp2tIXlhMamHc5U5BqbUwpXKXgiLL p6PcfSSowVxqRTZzfSWo1qg4N5D4CDOO5/Eq7mtMHNmXZgUaPRJaJptcjv5bjPA4 QyPsRHQGUSJyB2HIMkshq6yis7wc5J/64easn9j024EMpAfC+52mz6IqSyca2sY= =ejcF -----END PGP SIGNATURE----- --tsOsTdHNUZQcU9Ye--
Want to link to this message? Use this URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?20100911160930.GB3214>