Commit Graph

217 Commits

Author SHA1 Message Date
Ruslan Ermilov
a3089261bc Use Groff versions of man(7) and mdoc(7) manpages.
mdoc.samples(7) is superseded by mdoc(7).
2001-04-17 12:48:14 +00:00
Ruslan Ermilov
8f00082cd6 Document /usr/include/fs/smbfs and /usr/include/netsmb.
Submitted by:	bp
2001-04-13 08:14:58 +00:00
Ruslan Ermilov
6405e53deb Record -lposix1e death. 2001-04-05 07:59:19 +00:00
Ruslan Ermilov
acaf79e1b9 MAN[1-9] -> MAN. 2001-03-27 13:48:25 +00:00
Ruslan Ermilov
99d2a6766d .St macro cleanup:
- spell the abbreviation of 1003.1 as ``POSIX.1''
- fixed the description of -p1003.1-90; it was sold as ISO/IEC 9945-1:1990
- removed -p1003.1b; it only existed as 1003.1b-1993 (-p1003.1b-93), and
  is part of 1003.1 since 1003.1-1996.
- replaced -p1003.1g (project) with -p1003.1g-2000 (approved draft)
- changed abbreviation of -isoC from ``ISO C'' to ``ISO C89''
- removed -iso9899 alias for -isoC
- IEC was missing from some names
- added abbreviation for -susv2 (``SUSv2'')
2001-03-12 17:19:38 +00:00
Ruslan Ermilov
c308228566 Update the BUGS section.
The first bug is fixed in tmac.doc, revision 1.21.
The second bug fixed in doc-common, revision 1.33.
2001-03-01 12:58:54 +00:00
Ruslan Ermilov
589a5e341f /^\.St/ s/-iso9945-1/-p1003.1-96/ 2001-02-26 14:48:38 +00:00
Bruce Evans
1a030b1cbc Don't set a bad example by putting the function type in ".Fo". 2001-02-06 01:42:56 +00:00
Ruslan Ermilov
d0353b836e mdoc(7) police: split punctuation characters + misc fixes. 2001-02-01 16:38:02 +00:00
Ben Smithurst
92fbe861c6 Actually add build.7 to the Makefile, 2 months late.
PR:		24405
Submitted by:	Mike Meyer <mwm@mired.org>
2001-01-17 11:11:02 +00:00
Chris Costello
d7a0ba44f9 o Clear up explanations of various entries (includes spelling, grammar,
punctuation, and explanations that are just plain wrong)
o Add missing entries
o Remove entries for directories that do not exist

Submitted by:	Rich Morin <rdm@cfcl.com> (for the most part)
2001-01-13 18:38:00 +00:00
Ben Smithurst
4f38ddf643 fix typo; file -> files
Submitted by:	Alexey Dokuchaev <danfe@inet.ssc.nsu.ru>
2001-01-13 17:49:34 +00:00
Maxim Sobolev
e0a5f02bc3 Add getenv(3) and setenv(3) into ``See also'' section. 2001-01-01 23:26:54 +00:00
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
Alexey Zelkin
7547562461 Fix typos.
PR:		docs/15781
Submitted by:	Christian Weisgerber <naddy@mips.rhein-neckar.de>
2000-01-07 13:20:55 +00:00
Jun-ichiro itojun Hagino
1522ff5b28 bring in description for KAME IPv6 changes.
XXX it looks that sysctl.3 lacks most of PF_INET items.
Reviewed by:	shin
Obtained from:	KAME (netbsd-current)
2000-01-06 03:47:57 +00:00
Tim Vanderhoek
7ec24193b6 .Xr pkg_version 1 2000-01-02 17:55:03 +00:00
Jeroen Ruigrok van der Werven
bffd29ff1c Fix some typo's.
PR:		15678
Submitted by:	Christian Weisgerber <naddy@mips.rhein-neckar.de>
1999-12-27 11:02:43 +00:00
Daniel C. Sobral
65c9393d40 Add /boot. 1999-12-08 22:03:44 +00:00
Mike Pritchard
98fb084859 Update mdoc(7) and mdoc.samples(7) to list the preferred order
of manual page sections.  Make the two man pages consistent
with each other in the headers they list and they order they list
them in.

Note:  this is the preferred ordering.  All new man pages/additions
to man pages should try and follow this.  Existing man pages
should be left alone, unless you are making major changes  in
the man page and re-ordering of the sections is only a
minor part of the change.

PR:		doc/15352, doc/15353
1999-12-08 21:50:11 +00:00
Bill Fumerola
da2440e826 A bullet in the head to pkg_manage references. 1999-11-26 22:12:12 +00:00
Alexey Zelkin
b844b13b6a Fix file names in .FILES section.
Remove reference to obsolete files /us/src/share/tmac/README
1999-11-02 13:47:09 +00:00
Alexey Zelkin
af56842c46 Document .Ox and .Nx macros 1999-11-02 13:27:27 +00:00
Alexey Zelkin
385efa2c25 Document .St macro. 1999-11-02 13:23:56 +00:00
Alexey Zelkin
466f8f3f33 Fix invalid pathes in FILES section, mdoc(7)'fy 1999-10-30 14:10:31 +00:00
Mike Pritchard
6740f1c4ef Correctly escape a macro call in the description of the .D1 macro.
Also use the correct macro (.D1, not .Dl) to format the text,
and in the example output.

PR:		docs/14051
Submitted by:	<andrew@ugh.net.au>
1999-09-30 14:39:22 +00:00
Alexey Zelkin
c6d6e7726f Correct spelling : ascii -> ASCII
PR:		docs/13702
Submitted by:	Stephen J. Roznowski <sjr@home.com>
Reviewed by:	mpp
1999-09-20 09:15:23 +00:00
Matthew Dillon
ad27d06632 Minor cleanups
Reviewed by:	Matthew Dillon <dillon@backplane.com>
Submitted by:	 Alexey Zelkin <phantom@cris.net>
1999-09-19 05:30:12 +00:00
Matthew Dillon
d93b26d657 Bring security page uptodate, add more references, clarify some of
the comments, etc.
1999-09-18 18:21:38 +00:00
Alexey Zelkin
8b3038f872 Document .Ta macro.
Requested by: ru
Ok'ed by: mpp
1999-09-13 18:58:53 +00:00
Alexey Zelkin
19df0a6144 Fix typo: vi(8) -> vi(1)
Noticed by: ru
1999-09-13 18:38:53 +00:00
Alexey Zelkin
61f06d829c Document .Ox and .Nx macros.
Reviewed by:	mpp
1999-09-13 17:33:16 +00:00
Alexey Zelkin
a7299f79f8 Update to current state of filesystems layout (almost complete)
Stylize

PR:		docs/13229
Reviewed by:	mpp
1999-09-13 17:20:58 +00:00
Alexey Zelkin
f6f8f44dac mdoc(7) style fixes:
.Bx Free -> .Fx
Cross references to ports splited into different subsection

PR:		13256
Submitted by:	Alexey Zelkin <phantom@cris.net>
Reviewed by:	mpp
1999-09-04 14:55:22 +00:00
Peter Wemm
7f3dea244c $Id$ -> $FreeBSD$ 1999-08-28 00:22:10 +00:00
Tim Vanderhoek
d3936aa36e The "depends-list" target disappeared in r.1.300 (Dec. 12, 1998) of
bsd.port.mk.  Replace its occurrence in this file with a synonym.

PR:	docs/13255
1999-08-21 17:22:29 +00:00
Chris Costello
2a67fa4383 Remove superfluous `preserve' entry.
PR:		docs/13279
1999-08-21 04:43:59 +00:00
Mike Pritchard
066512998e Document some common ENVIRONMENT variables.
PR:		docs/13233
Submitted by:	Alexey Zelkin <phantom@cris.net>
1999-08-18 19:53:04 +00:00
Chris Costello
f437b38cf7 Fix a bunch of broken cross-references 1999-08-18 05:55:22 +00:00
Mike Pritchard
def37e7c68 Various man page cleanup:
- Sort xrefs
- FreeBSD.ORG -> FreeBSD.org
- Be consistent with section names as outlined in mdoc(7).
- Other misc mdoc cleanup.

PR:		doc/13144
Submitted by:	Alexey M. Zelkin <phantom@cris.net>
1999-08-15 10:48:36 +00:00
Mike Pritchard
5bb3eb09fd Document the AUTHORS section in mdoc(7). Expand the description
of the AUTHORS section in mdoc.samples(7) to document how the
authors name should be specified.

PR:		docs/13131
Pointed out by: Alexey M. Zelkin <phantom@cris.net>
1999-08-14 09:45:31 +00:00
David E. O'Brien
ac8011f83a Add portlint(1) and sort "SEE ALSO"'s. 1999-07-12 07:49:28 +00:00
Tim Vanderhoek
6b4c07361e - FreeBSD.ORG => FreeBSD.org
- Don't discourage people from using "make readmes"

 - Document WRKDIRPREFIX.
1999-07-12 02:33:47 +00:00
Mike Pritchard
878c59a1f6 Fix one error in my previous commit. The .Rv macro is not valid
for section 9 man pages.
1999-06-24 00:59:40 +00:00
Mike Pritchard
2c5eecfa59 Update mdoc.samples(7) to reflect that section 9 is a valid man page
section.  Update some descriptions of the various sections to
reflect that they are valid for section 9 man pages.  Add a table
of section numbers and what they are used for.
1999-06-24 00:18:46 +00:00
Mike Pritchard
145da7ad10 Document the IMPLEMENTATION NOTES section since we have a number of
man pages that use it.

PR:	10659
1999-06-15 19:03:54 +00:00
Nik Clayton
2e3912929b Fix the typos, and add new entries (like the /etc/periodic/ and /etc/mail/
directories).

PR:             docs/11695
Submitted by:   Chris Costello <chris@calldei.com>
1999-05-29 12:58:44 +00:00
Tim Vanderhoek
652627f040 Missed a ref to /usr/share/mk/bsd.port.mk 1999-05-02 05:04:26 +00:00
Tim Vanderhoek
2693c8b95a The bsd.port.mk has moved. 1999-04-29 21:41:11 +00:00
Guy Helmer
8575254514 Fix reference (FreeBSD 3.0.1 -> FreeBSD 3.1), remove apparent typo,
and fix reference to sysctl(8).

PR:		docs/10428 docs/10482
1999-03-15 15:43:10 +00:00
Guy Helmer
f6c2429116 Add a missing word and change a "then" to "than".
PR:		docs/9304 docs/9822
1999-03-02 03:55:34 +00:00