Re: patch for the afterboot.8 man page
On Thu, Jul 26, 2012 at 04:22:24PM +, John Long wrote: > > Index: src/share/man/man8/afterboot.8 > === > RCS file: /cvs/src/share/man/man8/afterboot.8,v > retrieving revision 1.136 > diff -u -r1.136 afterboot.8 > --- src/share/man/man8/afterboot.81 Mar 2012 04:38:10 - 1.136 > +++ src/share/man/man8/afterboot.826 Jul 2012 16:18:57 - > @@ -60,6 +60,9 @@ > Administrators will rapidly become more familiar with > .Ox > if they get used to using the high quality manual pages. > +.Pp > +The OpenBSD FAQ can be found at > +.Pa http://www.openbsd.org/faq . > .Ss Errata > By the time that you have installed your system, it is quite likely that > bugs in the release have been found. > i'm not a big fan of this, for a number of reasons: - i don;t like cross-referencing faq/man in general. hard to do right. - we should at least expect people to check out the web site, and the faq is obvious from there. - help(1) already references the faq. jmc
Re: Calomel.org [patch for the afterboot.8 man page]
On Fri, Jul 27, 2012 at 6:19 AM, ropers wrote: > Why is Pa only found in the MACRO REFERENCE section of mdoc(7) and not > in the MACRO OVERVIEW? Is it deprecated? It's under the "Semantic markup for command line utilities" subsection.
Re: Calomel.org [patch for the afterboot.8 man page]
On 26 July 2012 18:14, Matthew Dempsky wrote: > On Thu, Jul 26, 2012 at 8:23 AM, John Long wrote: >> +.Pa http://www.openbsd.org/faq . > > mdoc(7) says Lk should be used for hyperlinks, though we don't > actually do that in any of our manuals currently. I think it would be > nice to start doing so though so that HTML and PDF formatted manual > pages can provide proper hyperlinks. Why is Pa only found in the MACRO REFERENCE section of mdoc(7) and not in the MACRO OVERVIEW? Is it deprecated?
Re: patch for the afterboot.8 man page
On Thu, Jul 26, 2012 at 08:50:09AM -0700, Claus Assmann wrote: > On Thu, Jul 26, 2012, John Long wrote: > > > Third time's the charm? > > No. If you take a look at the file, you'll see that each new > sentence starts at a new line. That's what someone was trying to > tell you before... (this convention makes diffs simpler). Not having seen any examples... If this is ok, all fine and dandy. If not, you can all get yourselves another diffing boy ;) Index: src/share/man/man8/afterboot.8 === RCS file: /cvs/src/share/man/man8/afterboot.8,v retrieving revision 1.136 diff -u -r1.136 afterboot.8 --- src/share/man/man8/afterboot.8 1 Mar 2012 04:38:10 - 1.136 +++ src/share/man/man8/afterboot.8 26 Jul 2012 16:18:57 - @@ -60,6 +60,9 @@ Administrators will rapidly become more familiar with .Ox if they get used to using the high quality manual pages. +.Pp +The OpenBSD FAQ can be found at +.Pa http://www.openbsd.org/faq . .Ss Errata By the time that you have installed your system, it is quite likely that bugs in the release have been found. -- ASCII ribbon campaign ( ) Powered by Lemote Fuloong against HTML e-mail X Loongson MIPS and OpenBSD and proprietary/ \http://www.mutt.org attachmentsCode Blue or Go Home!
Re: Calomel.org [patch for the afterboot.8 man page]
On Thu, Jul 26, 2012 at 8:23 AM, John Long wrote: > +.Pa http://www.openbsd.org/faq . mdoc(7) says Lk should be used for hyperlinks, though we don't actually do that in any of our manuals currently. I think it would be nice to start doing so though so that HTML and PDF formatted manual pages can provide proper hyperlinks.
Re: patch for the afterboot.8 man page
On Thu, Jul 26, 2012, John Long wrote: > Third time's the charm? No. If you take a look at the file, you'll see that each new sentence starts at a new line. That's what someone was trying to tell you before... (this convention makes diffs simpler).
Re: Calomel.org [patch for the afterboot.8 man page]
A list member pointed out I could shorten the diff further by not including the index.html part of the URL. Third time's the charm? Index: src/share/man/man8/afterboot.8 === RCS file: /cvs/src/share/man/man8/afterboot.8,v retrieving revision 1.136 diff -u -r1.136 afterboot.8 --- src/share/man/man8/afterboot.8 1 Mar 2012 04:38:10 - 1.136 +++ src/share/man/man8/afterboot.8 26 Jul 2012 15:19:39 - @@ -59,7 +59,9 @@ .Pp Administrators will rapidly become more familiar with .Ox -if they get used to using the high quality manual pages. +if they get used to using the high quality manual pages. Another important +source of information is the OpenBSD FAQ at +.Pa http://www.openbsd.org/faq . .Ss Errata By the time that you have installed your system, it is quite likely that bugs in the release have been found. -- ASCII ribbon campaign ( ) Powered by Lemote Fuloong against HTML e-mail X Loongson MIPS and OpenBSD and proprietary/ \http://www.mutt.org attachmentsCode Blue or Go Home!
Re: Calomel.org [patch for the afterboot.8 man page]
On Thu, Jul 26, 2012 at 04:12:50PM +0200, David Coppa wrote: > Please, > > One sentence, one line... Ok, here we go: Index: src/share/man/man8/afterboot.8 === RCS file: /cvs/src/share/man/man8/afterboot.8,v retrieving revision 1.136 diff -u -r1.136 afterboot.8 --- src/share/man/man8/afterboot.8 1 Mar 2012 04:38:10 - 1.136 +++ src/share/man/man8/afterboot.8 26 Jul 2012 14:39:59 - @@ -59,7 +59,9 @@ .Pp Administrators will rapidly become more familiar with .Ox -if they get used to using the high quality manual pages. +if they get used to using the high quality manual pages. Another important +source of information is the OpenBSD FAQ at +.Pa http://www.openbsd.org/faq/index.html . .Ss Errata By the time that you have installed your system, it is quite likely that bugs in the release have been found. -- ASCII ribbon campaign ( ) Powered by Lemote Fuloong against HTML e-mail X Loongson MIPS and OpenBSD and proprietary/ \http://www.mutt.org attachmentsCode Blue or Go Home!
Re: Calomel.org [patch for the afterboot.8 man page]
On Thu, Jul 26, 2012 at 3:52 PM, John Long wrote: > On Thu, Jul 26, 2012 at 09:56:44AM -0300, Daniel Bolgheroni wrote: >> On Thu, Jul 26, 2012 at 07:47:46AM +0200, Joakim Dellrud wrote: >> > >> > Perhaps a resource of howtos/FAQ can be created since OpenBSD does not >> > change to much between releases? Or is that not interesting either? >> >> Maybe you should, _at least_, read the www page, _at least_ to know that >> a FAQ already exists. >> > > I was thinking if there was a reference to the FAQ in the afterboot man page > this should be less of an issue: > > Index: src/share/man/man8/afterboot.8 > === > RCS file: /cvs/src/share/man/man8/afterboot.8,v > retrieving revision 1.136 > diff -u -r1.136 afterboot.8 > --- src/share/man/man8/afterboot.8 1 Mar 2012 04:38:10 - 1.136 > +++ src/share/man/man8/afterboot.8 26 Jul 2012 13:50:30 - > @@ -60,6 +60,13 @@ > Administrators will rapidly become more familiar with > .Ox > if they get used to using the high quality manual pages. > +.Ss OpenBSD FAQ > +Many common and some not-so-common questions and answers about OpenBSD have > +been collected in the OpenBSD FAQ. It is one of the first places you should > +look for the answers to any tuning or setup questions. It has links to other > +informative documents that will help with OpenBSD-specific questions. It can > +be found at > +.Pa http://www.openbsd.org/faq/index.html. > .Ss Errata > By the time that you have installed your system, it is quite likely that > bugs in the release have been found. Please, One sentence, one line... cheers David
Re: Calomel.org [patch for the afterboot.8 man page]
On Thu, Jul 26, 2012 at 09:56:44AM -0300, Daniel Bolgheroni wrote: > On Thu, Jul 26, 2012 at 07:47:46AM +0200, Joakim Dellrud wrote: > > > > Perhaps a resource of howtos/FAQ can be created since OpenBSD does not > > change to much between releases? Or is that not interesting either? > > Maybe you should, _at least_, read the www page, _at least_ to know that > a FAQ already exists. > I was thinking if there was a reference to the FAQ in the afterboot man page this should be less of an issue: Index: src/share/man/man8/afterboot.8 === RCS file: /cvs/src/share/man/man8/afterboot.8,v retrieving revision 1.136 diff -u -r1.136 afterboot.8 --- src/share/man/man8/afterboot.8 1 Mar 2012 04:38:10 - 1.136 +++ src/share/man/man8/afterboot.8 26 Jul 2012 13:50:30 - @@ -60,6 +60,13 @@ Administrators will rapidly become more familiar with .Ox if they get used to using the high quality manual pages. +.Ss OpenBSD FAQ +Many common and some not-so-common questions and answers about OpenBSD have +been collected in the OpenBSD FAQ. It is one of the first places you should +look for the answers to any tuning or setup questions. It has links to other +informative documents that will help with OpenBSD-specific questions. It can +be found at +.Pa http://www.openbsd.org/faq/index.html. .Ss Errata By the time that you have installed your system, it is quite likely that bugs in the release have been found. /jl -- ASCII ribbon campaign ( ) Powered by Lemote Fuloong against HTML e-mail X Loongson MIPS and OpenBSD and proprietary/ \http://www.mutt.org attachmentsCode Blue or Go Home!
