mirror/freebsd
1
0
Fork 0
mirror of https://git.FreeBSD.org/src.git synced 2024-12-25 11:37:56 +00:00
Code Issues Releases Activity
61,748 Commits 339 Branches 3,553 Tags 2.1 GiB
b9f0d8be36
Commit Graph

187 Commits

Author SHA1 Message Date
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
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