Re: Calomel.org [patch for the afterboot.8 man page]

2012-07-27 Thread ropers
On 26 July 2012 18:14, Matthew Dempsky matt...@dempsky.org wrote:
 On Thu, Jul 26, 2012 at 8:23 AM, John Long codeb...@inbox.lv 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: Calomel.org [patch for the afterboot.8 man page]

2012-07-27 Thread Matthew Dempsky
On Fri, Jul 27, 2012 at 6:19 AM, ropers rop...@gmail.com 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]

2012-07-26 Thread John Long
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!



Re: Calomel.org [patch for the afterboot.8 man page]

2012-07-26 Thread David Coppa
On Thu, Jul 26, 2012 at 3:52 PM, John Long codeb...@inbox.lv 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]

2012-07-26 Thread John Long
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]

2012-07-26 Thread John Long
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]

2012-07-26 Thread Matthew Dempsky
On Thu, Jul 26, 2012 at 8:23 AM, John Long codeb...@inbox.lv 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.