Commit Graph

395 Commits

Author SHA1 Message Date
Chris Costello
07bf51c9b5 Be sure to point out that, by "mount point", one in /etc/fstab
is meant.

Submitted by:	John Hanley <jh_@yahoo.com>
Obtained from:	TrustedBSD Project
Sponsored by:	DARPA, NAI Labs
2001-12-30 03:47:06 +00:00
Chris Costello
bd49a87618 Document how to enable ACLs using extattrctl.
Obtained from:	TrustedBSD Project
Sponsored by:	DARPA, NAI Labs
2001-12-30 03:44:40 +00:00
Chris Costello
1c393056e6 Move UFS and FFS docs to section 7.
Obtained from:	TrustedBSD Project
Sponsored by:	DARPA, NAI Labs
2001-12-28 17:10:13 +00:00
Chris Costello
1fc841e3ab Add in the new security documentation guidelines document.
Obtained from:	NAI Labs CBOSS Project
Sponsored by:	DARPA, NAI Labs
2001-12-22 22:07:02 +00:00
Robert Watson
7270230e88 o s/softupdates/it/ to reduce over-use of 'softupdates' in a single
paragraph.
2001-12-22 21:02:33 +00:00
Robert Watson
b2e2e310fd o Softupdates is now enabled by default on non-root file systems. Update
language about softupdates to reference this fact, as well as slightly
  moderate the "recommend Softupdates for use on all filesystems" to
  "most filesystems" so as to be consistent with what sysinstall selects.
2001-12-22 21:01:07 +00:00
Robert Watson
60114b8024 o Most users will use sysinstall(8) for partition layout, rather than
disklabel(8), so add a reference to sysinstall(8).
2001-12-22 20:54:45 +00:00
Robert Watson
bcb3e22d61 o Expand on the definition of a sysctl, and add cross-references to
rc.conf and sysctl.conf.

MFC after:	3 days
2001-12-22 14:25:31 +00:00
Robert Watson
07f4b9740e o Refer to hw.ata.wc as a 'loader tunable' rather than a 'kernel variable'
for consistency with the rest of the document.  Since we've already
  described the properties of loader tunables elsewhere, remove the
  duplicate description of it being a boot-time property.

MFC after:	3 days
2001-12-22 14:21:20 +00:00
Robert Watson
d888f91feb o Update tuning(7) to reflect auto-tuning of kern.maxusers in recent
versions of FreeBSD.  This should be merged before 4.5-RELEASE, as this
  functionality is present in 4.5-RELEASE.

MFC after:	3 days
2001-12-22 14:19:20 +00:00
Ruslan Ermilov
f74d799555 mdoc(7) police: kill the undead whitespace at EOL. 2001-12-14 09:09:21 +00:00
Robert Watson
3b4fff26f3 o Various language and style tweaks.
Submitted by:	ru
2001-12-12 15:58:04 +00:00
Ruslan Ermilov
108c9afc50 mdoc(7) police: remove the debugging stuff I use to prevent
hyphenation (so that the output could be spell-checked).
2001-12-12 15:15:46 +00:00
Sheldon Hearn
3626f83327 Update the default newfs block and fragment sizes from 8192/1024 to
16384/2048.

Following recent discussions on the -arch mailing list, involving dillon
and mckusick, this change parallels the one made over a decade ago when
the default was bumped up from 4096/512.

This should provide significant performance improvements for most
folks, less significant performance losses for a few folks and
wasted space lost to large fragments for many folks.

For discussion, please see the following thread in the -arch archive:

Subject: Using a larger block size on large filesystems

The discussion ceases to be relevant when the issue of partitioning
schemes is raised.
2001-12-11 16:21:40 +00:00
Sheldon Hearn
2bd2a050ac Remove the advice relating to the number of cylinders per cylinder
group.  The highest possible value is calculated automatically since
rev 1.41 of src/sbin/newfs.c .
2001-12-10 09:26:30 +00:00
Robert Watson
eb22d616a0 When rfc1323 is mentioned in the context of buffer sizes, not that it
is enabled by default in FreeBSD.
2001-12-07 18:17:37 +00:00
Robert Watson
a695793d88 o Add a mention of kern.openfiles to the description of kern.maxfiles,
and suggest using this value to get a sense of the needs of the system.
2001-12-07 18:02:16 +00:00
Robert Watson
0fbfd3c17d o Fix spelling of allocations as allocates.
Submitted by:	silby
2001-12-06 20:27:44 +00:00
Robert Watson
98181c4975 o Reflect changed default such that keepalives are always enabled by
default now.  Discuss why that's good.  Note that there are still
  some situations where turning it off may be advantageous, including
  situations where there are network outages and it's desirable to
  have TCP sessions last beyond the outage.

Reviewed by:	fenner
Suggested by:	silby
2001-12-06 20:24:38 +00:00
Robert Watson
9aa92d5586 Moderate the recommendation that TCP keepalives always be turned on;
in some environments, this may result in the early termination of
legitimate TCP sessions during temporary network outages.  However,
maintain a strong recommendation that this be used when many network
clients are dialup.

Requested by:	fenner
2001-12-06 19:57:34 +00:00
Robert Watson
25eecbb5a4 o Add an additional .Pp between the send/recvbuffer comments and
the ones on ipfw.  Note to self: why does ipfw/dummynet count as
  a sysctl in tuning(7)?
2001-12-06 19:50:35 +00:00
Robert Watson
fe3e42064f o When describing kern.ipc.nsfbufs, use the slightly less colloquial
"modify" rather than the slightly more colloquial "mess with".
2001-12-06 19:48:48 +00:00
Robert Watson
657c740ed6 The default values for net.inet.tcp.sendspace and net.inet.tcp.recvspace
have been changed to 32k and 64k respectively.
2001-12-06 19:44:31 +00:00
Robert Watson
48c1691ebf vmiodirenable is now on by default; reflect that change in default,
and talk more about the reasons to turn it off (restricted memory
environments), and less about why to turn it on.
2001-12-06 19:39:33 +00:00
Robert Watson
32a124764d Reword parts of tuning(7) regarding loader tunables, which are refered
to in the document as "boot-time sysctls".  Instead, refer to them as
loader tunables.
2001-12-06 19:36:21 +00:00
Dima Dorfman
b94231daca Spelling police: "more then" - "more than" where appropriate. 2001-11-24 19:47:12 +00:00
Ruslan Ermilov
47bb57ceb4 mdoc(7) police: markup nits. 2001-11-21 13:33:30 +00:00
Ruslan Ermilov
4fab9eb9d6 mdoc(7) police: fix markup + generic cleanup. 2001-11-21 13:28:50 +00:00
Crist J. Clark
00b8804712 Document the /var/run/named directory.
Suggesteded by:		brian
2001-11-01 23:55:46 +00:00
Crist J. Clark
7558c91f77 Add a directory in /var/run to store ppp(8) command sockets.
PR:		bin/29966
Approved by:	brian
MFC after:	4
2001-11-01 23:44:12 +00:00
Assar Westerlund
9a5849d115 add /var/heimdal
absence noted by Archie Cobbs <archie@packetdesign.com>
2001-10-31 23:04:34 +00:00
Mike Silbersack
2fa7b7ca77 Update tuning so that it mentions maxusers, nmbclusters, and nsfbufs as
tunables in loader.conf rather than just kernel options.

MFC after: 3 days
2001-10-29 22:29:01 +00:00
Murray Stokely
c8123d63a2 Improve the wording of my last commit.
Submitted by:	sheldonh
2001-10-16 18:32:33 +00:00
Murray Stokely
325c1f2d13 Note that the contents of /tmp may or may not be kept between system
reboots.

Also add a `NOTES' section that reminds the reader that this man page
just documents the system default, and that the hierarchy of a given
site is at the system administrators discretion.

PR:		docs/29525
2001-10-13 21:48:57 +00:00
Ruslan Ermilov
32eef9aeb1 mdoc(7) police: Use the new .In macro for #include statements. 2001-10-01 16:09:29 +00:00
Kris Kennaway
5b7ce34e01 Oops, /var/spool/uucp needs to stay for serial port locking 2001-10-01 08:52:40 +00:00
Kris Kennaway
c3aa93665e Note removal of UUCP directories 2001-10-01 08:27:22 +00:00
Murray Stokely
bc58a19f1d Note that it might not be a good idea to mount /var 'noatime'.
PR:		docs/30675
Submitted by:	Eugene M. Kim <gene@nttmcl.com>, and
                Giorgos Keramidas <charon@labs.gr>
2001-09-24 07:35:37 +00:00
Jonathan Lemon
0d5d2695c0 Update to reflect the fact that net.inet.tcp.rfc1323 is on by default. 2001-09-17 03:49:51 +00:00
Ruslan Ermilov
0c0eb9be74 mdoc(7) police: sort FILES. 2001-09-04 10:08:19 +00:00
Alexander Langer
d33a962d07 Move /etc/defaults/make.conf to /usr/share/examples/etc/make.conf as
discussed on the arch@ mailinglist (after repo-copy).

sys.mk will .error if it finds /etc/defaults/make.conf but include
it anyways (this is the same behaviour as with the make.conf.local
removal).

/usr/share/examples/etc/make.conf has BDEFLAGS commented out now,
since it's only an example file.

Adjust all textes that talk about make.conf or defaults/make.conf to
match the new situation.
2001-08-30 22:44:51 +00:00
Ruslan Ermilov
7bf248defc Mentions about /var/spool/secretmail were deleted in BSD.var.dist,v 1.2. 2001-08-22 10:21:19 +00:00
Ruslan Ermilov
64b90fce72 Even more libss removal. 2001-08-20 15:41:15 +00:00
Ruslan Ermilov
753d686d34 mdoc(7) police: s/BSD/.Bx/ where appropriate. 2001-08-14 10:01:54 +00:00
Ruslan Ermilov
d013e3f544 mdoc(7) police: s/NetBSD/.Nx/ where appropriate. 2001-08-13 17:00:36 +00:00
Ruslan Ermilov
57e4378bf6 mdoc(7) police: protect trailing full stops of abbreviations
with a trailing zero-width space: `e.g.\&'.
2001-08-10 13:45:36 +00:00
Ruslan Ermilov
c4d9468ea0 mdoc(7) police:
Avoid using parenthesis enclosure macros (.Pq and .Po/.Pc) with plain text.
Not only this slows down the mdoc(7) processing significantly, but it also
has an undesired (in this case) effect of disabling hyphenation within the
entire enclosed block.
2001-08-07 15:48:51 +00:00
Ruslan Ermilov
1d719d1ca1 mdoc(7) police: don't use enclosure macros with plain text. 2001-07-18 15:00:46 +00:00
Nik Clayton
8b4611ee0f Note which entries are created by sysinstall(8).
Requested by:	ru
2001-07-16 16:09:21 +00:00
Daniel Harris
c8c7c06a4a Fix assorted typos. 2001-07-14 22:41:05 +00:00
Jens Schweikhardt
c1f3e4bf21 Removed whitespace at end-of-line; no content changes. I simply did
cd src/share; find man[1-9] -type f|xargs perl -pi -e 's/[ \t]+$//'

BTW, what editors are the culprits? I'm using vim and it shows
me whitespace at EOL in troff files with a thick blue block...

Reviewed by:	Silence from cvs diff -b
MFC after:	7 days
2001-07-14 19:41:16 +00:00
Ben Smithurst
d6b52729a0 fix typo: vise versa -> vice versa
PR:		28926
Submitted by:	Michael Lucas <mwlucas@blackhelicopters.org>
2001-07-12 20:40:25 +00:00
Ruslan Ermilov
63b2f7728a mdoc(7) police: eliminate warnings. 2001-07-10 18:43:07 +00:00
Ruslan Ermilov
0c93b033d5 mdoc(7) police: sort SEE ALSO xrefs. 2001-07-10 17:52:29 +00:00
Ruslan Ermilov
3d45e180f4 mdoc(7) police: removed HISTORY info from the .Os call. 2001-07-10 15:31:11 +00:00
Sheldon Hearn
d193eadbdf Fix typo: "fending of" -> "fending off" 2001-07-10 14:09:37 +00:00
Dima Dorfman
70d51341bf mdoc(7) police: remove extraneous .Pp before and/or after .Sh. 2001-07-09 09:54:33 +00:00
Matthew Dillon
037fbe4424 Fix type-o's, revamp section on the /tmp softlink, add sections for a
couple more sysctl's, add a section on mount options.
2001-07-07 17:43:20 +00:00
Ruslan Ermilov
5521ff5a4d mdoc(7) police: sort SEE ALSO xrefs (sort -b -f +2 -3 +1 -2). 2001-07-06 16:46:48 +00:00
Nik Clayton
302bba85d6 /dist is a mount point used by sysinstall(8), not an extraction directory. 2001-06-30 14:56:44 +00:00
Nik Clayton
cf348169cb Document dist/, cdrom/, compat/, and /usr/compat/, fix a couple of
{typ,think}os.

Submitted by:	Rich Morin <rdm@cfcl.com>
2001-06-26 14:03:11 +00:00
Dima Dorfman
159f80bfbc Reword the sentence that I screwed up in the last commit.
Submitted by:	Erik Trulsson <ertr1013@student.uu.se>
2001-06-24 20:34:31 +00:00
Dima Dorfman
a910f192bb Remove duplicate words. 2001-06-24 01:34:38 +00:00
Dima Dorfman
5a203488e4 mdoc(7) police: sort xrefs. 2001-06-24 01:17:07 +00:00
Dima Dorfman
9baaab27a0 OpenSSH doesn't forward keys by default. 2001-06-16 00:32:19 +00:00
Joerg Wunsch
4a70e151df Document /usr/include/dev/{ic,wi}.
Reminded by:	ru
2001-06-05 18:52:55 +00:00
Matthew Dillon
1a4c56a67d Fix type-o's, update page 2001-06-05 05:59:21 +00:00
Eric Melville
35f3d11437 Add sprog.7 to the list. 2001-06-04 22:15:44 +00:00
Eric Melville
ef73da6384 Add sprog.7, the beginnings of the secure programming guide.
Reviewed by:	ru
2001-06-04 15:32:44 +00:00
Ruslan Ermilov
0b381bf1fd Remove vestiges of MFS. 2001-06-01 10:07:28 +00:00
Matthew Dillon
fc32c80215 Add two new manual pages related to general firewall and tuning issues
Reviewed by: hackers
2001-05-27 23:14:27 +00:00
Ruslan Ermilov
1f4e04b562 Document /usr/include/fs/ntfs and /usr/include/fs/nwfs. 2001-05-26 12:04:02 +00:00
Ruslan Ermilov
1166fb516b - sys/msdosfs moved to sys/fs/msdosfs
- msdos.ko renamed to msdosfs.ko
- /usr/include/msdosfs moved to /usr/include/fs/msdosfs
2001-05-25 08:14:14 +00:00
Ruslan Ermilov
4f3d8832ff Document new /usr/include/fs include subdirs. 2001-05-23 17:22:38 +00:00
John Baldwin
120bcabcbf Replace references to the KERNEL variable with KERNCONF. 2001-05-17 23:23:25 +00:00
Jens Schweikhardt
e986850f9f Fixed typos: dependant -> dependent 2001-05-01 14:10:12 +00:00
Dima Dorfman
019de50b69 Reword a few things and document the search' and index' make targets.
PR:		26690
Submitted by:	Pete Fritchman <petef@databits.net>
2001-04-22 00:28:40 +00:00
Ruslan Ermilov
eb0838029f mdoc(7) police: normalize .Nd. 2001-04-18 15:54:10 +00:00
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
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