Commit Graph

154 Commits

Author SHA1 Message Date
Ruslan Ermilov
3136363f3e Prepare for mdoc(7)NG. 2000-12-29 09:18:45 +00:00
Ruslan Ermilov
d003b7796c mdoc(7) police: removed duplicate .Os calls. 2000-12-14 12:40:48 +00:00
Ruslan Ermilov
ed40311694 mdoc(7) police: removed history info from the .Os FreeBSD call. 2000-12-14 11:52:05 +00:00
Archie Cobbs
e449cfc4c7 Document /usr/include/isc.
Noticed by:	ru
2000-12-12 05:19:10 +00:00
Ruslan Ermilov
d7b336c076 mdoc(7) police: use canonical form of .Dd macro. 2000-12-11 15:47:53 +00:00
Ruslan Ermilov
d41608a89c Document /usr/include/netnatm and /usr/share/sendmail. 2000-12-11 13:41:57 +00:00
Ben Smithurst
47f77d8c57 Mention mergemaster(8).
Submitted by:	obrien
2000-11-24 10:22:08 +00:00
Ben Smithurst
7c20a49391 Use a more generic name for the compiler cross-reference. (cc instead of
gcc.)

Suggested by:	sheldonh (not sholdonh)
2000-11-23 14:44:45 +00:00
Ben Smithurst
a81996b6b8 * Say that ps, top, etc, "may not work" with the new kernel, rather than
"will not work", as in many cases they will.

Suggested by:	sholdonh

* Add cross-references to reboot(8) and shutdown(8)
2000-11-23 14:19:50 +00:00
Ben Smithurst
3faf5fc932 Add an example to explain the basic procedure to build the world.
Suggested by:	obrien
2000-11-23 14:00:26 +00:00
Ben Smithurst
786aa69adc Add two new manual pages to document the various options available in
make.conf, and the /usr/src building process.

PR:		22676
Submitted by:	Mike Meyer <mwm@mired.org>
Reviewed by:	nik, sheldonh
2000-11-22 14:04:26 +00:00
Ruslan Ermilov
f4d874a1db mdoc(7) police: do not split author names in the AUTHORS section. 2000-11-22 09:35:58 +00:00
Ruslan Ermilov
2ba69799de Make An macro understand two special arguments, -nosplit
and -split.  See the mdoc.samples(7) manpage for details.

Reviewed by:	sheldonh
2000-11-22 08:39:17 +00:00
Ruslan Ermilov
a8e0cb75cc mdoc(7) police: fixed the section reference to the mdoc.samples(7). 2000-11-21 08:12:23 +00:00
Ruslan Ermilov
4b66483fd8 mdoc(7) police: use the new features of the Nm macro. 2000-11-20 18:41:33 +00:00
Sheldon Hearn
88927276f9 Document the libcompat entry for the .Lb macro.
Submitted by:	phantom
2000-11-20 16:14:08 +00:00
Ruslan Ermilov
b5c508fba3 Use Fx macro wherever possible. 2000-11-14 11:20:58 +00:00
Mike Pritchard
ec9a57e8ac Do not terminate the SEE ALSO section example with a period.
The cross-reference list should not be terminated with any
type of punctuation at the end of the line.

Pointed-out-by: sheldonh
2000-11-13 15:54:47 +00:00
Ruslan Ermilov
726b61ab5f Avoid use of direct troff requests in mdoc(7) manual pages. 2000-11-10 17:46:15 +00:00
Josef Karthauser
c5bb0e9394 Scripts should contain a comment block describing what the script does. 2000-10-19 18:18:35 +00:00
Josef Karthauser
22bbcf38a7 Reference Larry Wall's perlstyle man page, and recommend it's use where
entries in this guide don't override it.

Requested by:	markm

Comment on tabulation style.
2000-10-18 21:57:37 +00:00
Josef Karthauser
e6e692447c Use 'unless' instead of 'if (! ... )' where it improves readability. 2000-10-18 18:01:35 +00:00
Josef Karthauser
32d219825c Opening braces should be at the end of the controlling line. Else
and elsif belong on the same line as the closing brace for the
previous if or elsif block.

Suggested by:	des
2000-10-18 17:48:10 +00:00
Josef Karthauser
a2a307a14d Contract a statement that's too verbose. 2000-10-18 17:34:43 +00:00
Josef Karthauser
a669270dee There are enough examples of using 'my $var = ...' definitions, so remove
one.
2000-10-18 17:32:21 +00:00
Josef Karthauser
a4d70fdb47 All variables should be commented.
Local variables should be separated from function arguments by a
blank line.

Suggested by:	des
2000-10-18 17:25:59 +00:00
Josef Karthauser
ab6f5f0d9c Make subroutine prototypes mandatory.
The main code should be wrapped in a MAIN:{ ... } declaration.

Suggested by:	des
2000-10-18 17:21:54 +00:00
Josef Karthauser
d17bce98be Fix the places that I missed last commit: 'vars' not 'var'. 2000-10-18 17:12:07 +00:00
Josef Karthauser
e77c53b0be Correction: 'use vars ..' not 'use var'.
Submitted by:	des
2000-10-17 15:50:22 +00:00
Josef Karthauser
fa0be99954 Build and install the perl.style(7) manual page. 2000-10-17 15:33:29 +00:00
Josef Karthauser
e79ac7ee3a Reclarify variable definition blocks.
Ask programmers to use modules where possible instead of reinventing
  the wheel.
Use 'chomp' not 'chop' please.
Fixup some mdoc.
2000-10-17 15:32:57 +00:00
Josef Karthauser
3194300995 An initial draft of a style guide for perl scripts in the tree. 2000-10-17 02:51:03 +00:00
David E. O'Brien
c13ded1868 Add `isoC-99' to the list of availble abbreviations. 2000-10-11 19:30:41 +00:00
Murray Stokely
05f976924e Fix typo : s/maintaince/maintenance/ 2000-10-03 07:38:41 +00:00
Alexey Zelkin
2006c179e2 Document 'libusb' option for .Lb macro 2000-09-22 14:36:06 +00:00
David E. O'Brien
1a3ad32399 The kernel is now known as `kernel.ko' and it and its matching modules
live in ``/boot/kernel/''.
2000-09-06 17:51:31 +00:00
Brian Feldman
ba66454b69 Capitalize the last two entries. Note that i8254 is a timer. Report
that TSC is for any fifth-gneration of later x86 processor, not an
i586, and document that it _is_ available to applications.
2000-07-28 21:48:58 +00:00
Mike Pritchard
db3af44eb0 Remove some mis-leading text from the "Libraries" section. 2000-06-24 23:02:01 +00:00
Ruslan Ermilov
30592a1799 Document /usr/lib/aout.
PR:		conf/18167
2000-06-07 07:41:09 +00:00
Ruslan Ermilov
c5f8035bad /usr/mdec has gone 1.5 years ago. 2000-06-05 16:14:51 +00:00
Sheldon Hearn
f167d7fb3e Fix miscellaneous mdoc macro argument limit infringements.
PR:		18465
Reported by:	Kazu TAKAMUNE <takamune@avrl.mei.co.jp>
2000-05-09 14:02:06 +00:00
Alexey Zelkin
6d0a2eea64 Add libipsec to the list of available libraries 2000-05-04 17:58:22 +00:00
Alexey Zelkin
a8e2142b2f Document .Fx', .Nx' and `.Ox' macros as callable and parsable. 2000-05-04 16:25:27 +00:00
Alexey Zelkin
be08c04ecb Add expanded information about .Lb macro 2000-04-23 14:50:38 +00:00
Alexey Zelkin
e4c2649e73 Add information about newly added .Lb macro 2000-04-23 14:49:22 +00:00
Nik Clayton
8596de5303 Note that openssh/ssl are in the tree now, and use the correct section
numbers for accton(8), sshd(8), and syslogd(8).

PR:             docs/17100
Submitted by:   Udo Erdelhoff <ue@nathan.ruhr.de>
2000-03-07 13:59:26 +00:00
Sheldon Hearn
1111b49c35 Remove single-space hard sentence breaks. These degrade the quality
of the typeset output, tend to make diffs harder to read and provide
bad examples for new-comers to mdoc.
2000-03-03 14:05:08 +00:00
Kris Kennaway
2bfea7a2b0 Document OpenSSL directories. 2000-01-30 04:22:11 +00:00
Chris Costello
ab6afc855d Update the /usr/include/ hierarchy for the cam/ and cam/scsi/ directories.
PR:		16345
Submitted by:	Nick Hibma (henny) <n_hibma@webweaving.org>
2000-01-29 06:42:23 +00:00
Nick Hibma
fcc56d9930 Install the USB include files in /usr/include/dev/usb.
We should still sort out some way of avoiding the clutter. Not all files
should be there.

Prompted by:   Louis A. Mamakos <louie@TransSys.COM>
2000-01-25 09:24:23 +00:00