Commit Graph

299 Commits

Author SHA1 Message Date
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
Guy Helmer
568e4cbb74 Apply mdoc macros, remove some spacing that caused unexpected line breaking,
and fix some spelling errors.  (I also took the liberty of converting the
reference to LKMs to KLDs.)

PR:		docs/9238 docs/9305
1999-03-02 03:45:47 +00:00
Jordan K. Hubbard
e430ec940a away go lkms, in come klds. 1999-02-15 00:56:38 +00:00
Joseph Koshy
4571317a76 Typo fix. Remove reference to non-existent edit(1).
Pointed out by:	Sue Blake <sue@welearn.com.au>
1999-02-04 07:13:49 +00:00
Tim Vanderhoek
3fea87d29e -make clear need to use the upgrade kit
-add "depends" to list of recursive targets
-consistent capitilization of FreeBSD.ORG
-remove description of PATCH_DEBUG
-add .Xr to portcheckout(1) and pib(1)
1998-12-30 17:32:47 +00:00
Matthew Dillon
3128fa34a9 Fix copyright info. Man page was written by Matt, not CSRG :-) 1998-12-26 05:19:42 +00:00
David E. O'Brien
6ac7e896c3 Hack -> compromise
hacker -> intruder (couldn't desired between this and 'cracker')
config -> configuration
sorted crossreferences
spell checked

Overall very good content, but we need one of our wordsmiths to change the
tone to match the CSRG manpages.
1998-12-25 23:39:01 +00:00
Matthew Dillon
7626ae52a5 Grammer / Consistancy update
Submitted by:	Eivind Eklund <eivind@yes.no>
1998-12-22 19:02:51 +00:00
Joseph Koshy
82315fb071 Clarify that "/usr/share" is used for architecture independent files
and need not be restricted to ASCII text files.

PR:		docs/9124
Submitted by:	Mattias Pantzare <pantzer@ludd.luth.se>
1998-12-21 05:57:57 +00:00
Matthew Dillon
f063d76ae3 Moved security page from man 1 to man 7 1998-12-20 20:12:17 +00:00
Joseph Koshy
9a963d0aac Fix typo ('strait' -> 'straight').
PR:		docs/8956
Submitted by:	Kaneda Hiloshi <vanitas@ma3.seikyou.ne.jp>
1998-12-04 00:51:17 +00:00
Joseph Koshy
8c5b93b9d2 Fix bugs in mdoc.samples(7): clean up references, quote usage of macros,
correct typos.

PR:		docs/9942
Submitted by:	vanitas@ma3.seikyou.ne.jp
Reviewed by:	jkoshy
1998-12-03 03:38:45 +00:00
Bill Fumerola
f41840a6fc Macro "Re" stands for "Reference End", not "Reference Start"
PR:		docs/8727
Reviewed by:	jdp
Submitted by:	Kazuo Horikawa <horikawa@jp.FreeBSD.org>
1998-12-01 19:58:58 +00:00
Joseph Koshy
c0226436b4 Add a manual page for man(7).
Thanks-to:	Joerg Wunsch for sending me a sample page for inspiration.
1998-11-26 00:21:24 +00:00
Tim Vanderhoek
805a2777e4 SEE ALSO http://www.FreeBSD.ORG/ports 1998-06-29 06:54:34 +00:00
Tim Vanderhoek
edac0054b0 Grammar touch-up. 1998-06-23 04:38:50 +00:00
Philippe Charnier
aaf1f16e39 .Sh AUTHOR -> .Sh AUTHORS according to mdoc specs.
Use .An/.Aq.
1998-03-12 07:31:21 +00:00
Tim Vanderhoek
83d04c760a Change documentation for `make package' (Thanks (indirectly) O'Brien!).
Document `make readmes'.  This is getting old, and the intent is to
stop questions regarding it; however, I have a suspicion documenting it
will work counter to ending questions about it and am mentally prepared
to see it go-ooooooooo.......
1998-02-07 21:07:51 +00:00
Tim Vanderhoek
65dfa7aaf3 Fill-in and fill-out a little.
Correct a small misfact.  :)
1998-01-31 02:55:58 +00:00
David E. O'Brien
b66c141b50 Get the year right. ;) 1998-01-28 01:12:05 +00:00
David E. O'Brien
e4b22b63f2 Explains targets and environ vars much better.
Mostly submitted by:	imp
1998-01-28 01:09:46 +00:00
Philippe Charnier
0a52caf8e9 Correct a path. 1997-12-08 07:44:20 +00:00
David E. O'Brien
4000f72f04 Add an introductory manpage for the ports system. 1997-11-09 06:05:45 +00:00
Wolfram Schneider
439edf13e0 PR: docs/3979
better wording

Submitted by: Tim Vanderhoek <hoek@hwcn.org>, Gary Howland <gary@hotlava.net>
1997-09-13 17:52:36 +00:00
John Polstra
c12fbac488 "It's" -> "Its" in two places. 1997-09-04 20:59:33 +00:00
Mike Pritchard
dd5527c607 Use the .Fx macro for FreeBSD references for releases prior to 2.0.
Use the .Tn macro for generic FreeBSD references.  Cleanup other
formatting problems noticed while making the above changes.
1997-03-21 20:14:15 +00:00
Mike Pritchard
0728623156 Document the .An (author name) macro. Also cleanup some other problems
I noticed while editing these man pages.

Usage: .An Author_name

Example:

This manual page was written by
.An Mike Pritchard Aq mpp@FreeBSD.ORG .

Produces:

This manual page was written by Mike Pritchard <mpp@FreeBSD.ORG>.
1997-03-20 16:04:04 +00:00
Mike Pritchard
8889d6ac3a Document the .Rv (return values) macro.
".Rv -std atexit" will generate the following text:

The atexit() function returns the value 0 if successful; otherwise the
value -1 is returned and the global variable errno is set to indicate the
error.
1997-03-19 21:01:45 +00:00
Mike Pritchard
5b945c8686 Update the table of contents such as it is to reflect my previous change. 1997-03-19 20:31:42 +00:00
Mike Pritchard
c41c97fab9 Document the previously undocumented .Bf (begin font mode) macro.
Moved the descriptions of the .Em, .Li and .Sy macros into
the new "Font Modes" sub-section along with .Bf, since they are
all related.
1997-03-19 20:16:50 +00:00
Mike Pritchard
aef772c06b The "usage" line for the .Ic macro incorrectly says that it is
the .Li macro.
1997-03-18 20:00:36 +00:00
Wolfram Schneider
2641f58969 Sync with /etc/mtree/BSD.*.dist 1997-03-09 22:39:56 +00:00
Wolfram Schneider
f71e91691c Sync with /etc/mtree/BSD.root.dist. 1997-03-08 15:54:56 +00:00
Wolfram Schneider
c7fa2a6521 Add variable MAIL. 1997-03-08 14:41:44 +00:00
John-Mark Gurney
ac5afce161 add missing cvs Id lines. 1997-03-07 03:28:23 +00:00
Peter Wemm
e25aeca937 Revert $FreeBSD$ back to $Id$ 1997-02-22 13:26:29 +00:00
Mike Pritchard
15623f37d0 Typo fix.
Obtained from: NetBSD
1997-02-13 17:38:31 +00:00
Mike Pritchard
6a6c4c22d2 Fix a bunch of man pages to stop abusing the .Nm macro, along
with some other minor fixes for some problems I noticed
while making these changes.

Pointed out by:	bde
1997-02-05 15:07:37 +00:00
Mike Pritchard
63001a3fff Add a missing quote.
Obtained from: OpenBSD
1997-01-15 05:18:29 +00:00
Jordan K. Hubbard
1130b656e5 Make the long-awaited change from $Id$ to $FreeBSD$
This will make a number of things easier in the future, as well as (finally!)
avoiding the Id-smashing problem which has plagued developers for so long.

Boy, I'm glad we're not using sup anymore.  This update would have been
insane otherwise.
1997-01-14 07:20:47 +00:00
Wolfram Schneider
c15a12df0f add cross reference to cd(1), where CDPATH variable is explained 1997-01-09 21:04:10 +00:00
Mike Pritchard
66a5a22607 Mention the new mdoc examples in /usr/share/examples/mdoc. 1997-01-02 20:50:23 +00:00
Mike Pritchard
eb6d684623 Don't claim that the section 7 man pages are mostly troff related,
since they are not.
1996-12-26 22:41:18 +00:00
Mike Pritchard
8044b10425 Mention that cross references in the SEE ALSO section should be
sorted by section number and then placed in alphabetical order.
1996-12-26 22:34:23 +00:00
Wolfram Schneider
0b992c1d66 Sort cross references. 1996-12-26 16:16:37 +00:00
Mike Pritchard
6071eeacb3 Update mdoc.samples(7) to match what is now
installed in /usr/share/misc/mdoc.template
1996-12-21 22:02:30 +00:00
Mike Pritchard
aab5e1b6d0 Minor formatting/style fixes.
Submitted by:	Sandro Sigala <sandro@cat.local.net> as part of PR # 2134
1996-12-09 07:45:59 +00:00
Andrey A. Chernov
b96aebd585 Fix syntax error loc->doc 1996-12-04 09:42:39 +00:00
David E. O'Brien
f5001497c2 First cut at adding a little bit about the ports framework's dir structure. 1996-12-04 08:49:52 +00:00
Wolfram Schneider
7ae31dc93d rename obsolete 'TZ=US/Pacific' example to 'TZ=America/Los_Angeles'
close PR #2125
1996-11-30 00:29:51 +00:00
Jordan K. Hubbard
e0752a1775 Try to get some of the most egregiously old cruft out of here. 1996-06-20 19:45:23 +00:00
Mike Pritchard
e40f3f85d4 Do not install the now unsupported netns and netiso
related man pages.  Comment out cross references to those man
pages from other man pages.
1996-04-08 05:15:09 +00:00
Mike Pritchard
edf0e5b3f8 Correct some man page xrefs, and some other minor changes to bring some
man pages up to mdoc guidelines and fix some minor formatting glitches.
Also fixed a number of man pages to not abuse the .Xr macro to
display functions and path names and a lot of other junk.
1996-04-08 04:18:31 +00:00
Mike Pritchard
868f8f4197 Add the Ap macro to the macro table documentation (it generates an
apostrophe for those of you that were wondering).
1996-04-07 23:57:14 +00:00
Mike Pritchard
24e89d55ba Bring clocks(7) into line with mdoc standards.
Reviewed by:	joerg
1996-04-07 21:12:10 +00:00
Mike Pritchard
906c1e27fc Correct some man page cross references and file location references. 1996-04-07 00:06:21 +00:00
Joerg Wunsch
c6e1c8d3c1 Add clocks(7).
Submitted by:	bde
1996-04-05 08:51:22 +00:00
Mike Pritchard
4abbfcd7ec Document the new ".Fx" macro in the mdoc man pages. I also
changed the update(4) man page to use this new macro just to
have something to test it on.
1996-02-12 19:27:32 +00:00
Mike Pritchard
bcff8e2ae4 Another round of man page cleanups.
Down to only about 100 items left to cleanup! :-)
1996-02-12 04:57:03 +00:00
Mike Pritchard
4a8d02835c Fix a bunch of spelling errors in a bunch of man pages. 1996-01-30 13:52:50 +00:00
Andrey A. Chernov
01eddd5836 Remove startup_locale reference.
Add LANG variable description.
1995-11-02 12:53:26 +00:00
Bruce Evans
ee911e5456 Remove private rules for clean, depend, lint, tags and install.
The private clean rules have been broken since we started
building compressed man pages in the obj directory and the
others don't do anything different from the general rules.
1995-10-21 11:02:01 +00:00
Andrey A. Chernov
7c2aa513e6 Document ENABLE_STARTUP_LOCALE env. variable 1995-10-12 23:54:35 +00:00
Bruce Evans
278e874772 Remove bogus references to /usr/ucb. 1995-06-26 06:40:23 +00:00
Rodney W. Grimes
44204187ec Remove trailing whitespace. 1995-05-30 06:58:14 +00:00
Garrett Wollman
8ccf48ea2d Make man page installation work for ``unattached'' and kernel pages. 1994-08-09 18:41:38 +00:00
David Greenman
b3bfc7199e Converted 'vmunix' to 'kernel'. 1994-08-05 09:14:37 +00:00
Rodney W. Grimes
afe61c1516 BSD 4.4 Lite Share Sources 1994-05-30 19:09:18 +00:00