diff options
author | 2000-03-19 19:25:21 +0000 | |
---|---|---|
committer | 2000-03-19 19:25:21 +0000 | |
commit | 1f53fde168acc1d0dd0875ec542fe363338e18f8 (patch) | |
tree | 5a98000f94a8db3b6356bfd716250a1ae13fa5e3 /share/man/man7 | |
parent | Remove hard sentence breaks. Add $OpenBSD$ tags where appropriate. Some other (diff) | |
download | wireguard-openbsd-1f53fde168acc1d0dd0875ec542fe363338e18f8.tar.xz wireguard-openbsd-1f53fde168acc1d0dd0875ec542fe363338e18f8.zip |
Various cleanups.
Diffstat (limited to 'share/man/man7')
-rw-r--r-- | share/man/man7/environ.7 | 9 | ||||
-rw-r--r-- | share/man/man7/mailaddr.7 | 32 | ||||
-rw-r--r-- | share/man/man7/mdoc.7 | 9 | ||||
-rw-r--r-- | share/man/man7/mdoc.samples.7 | 32 | ||||
-rw-r--r-- | share/man/man7/operator.7 | 1 | ||||
-rw-r--r-- | share/man/man7/ports.7 | 60 | ||||
-rw-r--r-- | share/man/man7/securelevel.7 | 35 |
7 files changed, 105 insertions, 73 deletions
diff --git a/share/man/man7/environ.7 b/share/man/man7/environ.7 index ee313935f7d..43fdd93699d 100644 --- a/share/man/man7/environ.7 +++ b/share/man/man7/environ.7 @@ -1,4 +1,4 @@ -.\" $OpenBSD: environ.7,v 1.8 2000/02/14 15:19:47 aaron Exp $ +.\" $OpenBSD: environ.7,v 1.9 2000/03/19 19:25:34 aaron Exp $ .\" $NetBSD: environ.7,v 1.4 1995/07/03 19:45:07 jtc Exp $ .\" .\" Copyright (c) 1983, 1990, 1993 @@ -47,7 +47,8 @@ An array of strings called the .Dq environment is made available by .Xr execve 2 -when a process begins. By convention these strings have the form +when a process begins. +By convention these strings have the form .Ar name Ns No = Ns Ar value . The following variables are recognized by various commands: .Bl -tag -width BLOCKSIZE @@ -141,8 +142,8 @@ and .Xr termcap . .It Ev TERMPATH A sequence of pathnames of termcap files, separated by colons or spaces, -which are searched for terminal descriptions in the order listed. Having -no +which are searched for terminal descriptions in the order listed. +Having no .Ev TERMPATH is equivalent to a .Ev TERMPATH diff --git a/share/man/man7/mailaddr.7 b/share/man/man7/mailaddr.7 index 6fa52345647..31122b2de70 100644 --- a/share/man/man7/mailaddr.7 +++ b/share/man/man7/mailaddr.7 @@ -1,4 +1,4 @@ -.\" $OpenBSD: mailaddr.7,v 1.4 1999/05/23 14:11:09 aaron Exp $ +.\" $OpenBSD: mailaddr.7,v 1.5 2000/03/19 19:25:34 aaron Exp $ .\" $NetBSD: mailaddr.7,v 1.3 1994/11/30 19:07:17 jtc Exp $ .\" .\" Copyright (c) 1983, 1987, 1990, 1993 @@ -42,12 +42,13 @@ .Nd mail addressing description .Sh DESCRIPTION Mail addresses are based on the Internet protocol listed at the end of this -manual page. These addresses are in the general format +manual page. +These addresses are in the general format .Pp .Dl user@domain .Pp -where a domain is a hierarchical dot separated list of subdomains. For -example, a valid address is: +where a domain is a hierarchical dot separated list of subdomains. +For example, a valid address is: .Pp .Dl eric@CS.Berkeley.EDU .Pp @@ -59,7 +60,8 @@ to CS over the Ethernet rather than going via the Berkeley Internet gateway. .Ss Abbreviation Under certain circumstances it may not be necessary to type the entire -domain name. In general, anything following the first dot may be omitted +domain name. +In general, anything following the first dot may be omitted if it is the same as the domain from which you are sending the message. For example, a user on .Dq calder.berkeley.edu @@ -71,7 +73,8 @@ since it is the same on both sending and receiving hosts. .Ss Compatibility Certain old address formats are converted to the new format to provide -compatibility with the previous mail system. In particular, +compatibility with the previous mail system. +In particular, .Pp .Dl user@host .Pp @@ -103,14 +106,17 @@ on for compatibility with older UUCP hosts. Domain names (i.e., anything after the .Dq @ sign) may be given in any mixture -of upper and lower case with the exception of UUCP hostnames. Most hosts +of upper and lower case with the exception of UUCP hostnames. +Most hosts accept any combination of case in user names, with the notable exception of MULTICS sites. .Ss Route-addrs Under some circumstances it may be necessary to route a message through -several hosts to get it to the final destination. Normally this routing +several hosts to get it to the final destination. +Normally this routing is done automatically, but sometimes it is desirable to route the message -manually. Addresses which show these relays are termed +manually. +Addresses which show these relays are termed .Dq route-addrs . These use the syntax: .Pp @@ -127,8 +133,8 @@ path to .Dq hostc . .Pp Route-addrs occur frequently on return addresses, since these are generally -augmented by the software at each host. It is generally possible to ignore -all but the +augmented by the software at each host. +It is generally possible to ignore all but the .Dq user@hostc part of the address to determine the actual sender. .Pp @@ -151,8 +157,8 @@ Some other networks can be reached by giving the name of the network as the last component of the domain. .Em This is not a standard feature and may -not be supported at all sites. For example, messages to CSNET or BITNET sites -can often be sent to +not be supported at all sites. +For example, messages to CSNET or BITNET sites can often be sent to .Dq user@host.CSNET or .Dq user@host.BITNET , diff --git a/share/man/man7/mdoc.7 b/share/man/man7/mdoc.7 index 3a1cb145a47..c731695ce19 100644 --- a/share/man/man7/mdoc.7 +++ b/share/man/man7/mdoc.7 @@ -1,4 +1,4 @@ -.\" $OpenBSD: mdoc.7,v 1.13 2000/03/04 22:19:33 aaron Exp $ +.\" $OpenBSD: mdoc.7,v 1.14 2000/03/19 19:25:34 aaron Exp $ .\" .\" Copyright (c) 1991, 1993 .\" The Regents of the University of California. All rights reserved. @@ -58,8 +58,8 @@ a detailed explanation on using the package, see the tutorial sampler .Xr mdoc.samples 7 . .Pp -The macros are described in two groups. The first -includes the structural and physical page layout macros. +The macros are described in two groups. +The first includes the structural and physical page layout macros. The second contains the manual and general text domain macros which differentiate the .Nm -\mdoc @@ -188,7 +188,8 @@ is used. End-display (matches \&.Bd). .It Li \&.Bl Begin-list. -Create lists or columns. Options: +Create lists or columns. +Options: .Bl -tag -width flag -compact .It Em List-types .Bl -column "xbullet " -compact diff --git a/share/man/man7/mdoc.samples.7 b/share/man/man7/mdoc.samples.7 index 09b47367691..9b526ca519f 100644 --- a/share/man/man7/mdoc.samples.7 +++ b/share/man/man7/mdoc.samples.7 @@ -1,4 +1,4 @@ -.\" $OpenBSD: mdoc.samples.7,v 1.21 2000/03/04 22:19:33 aaron Exp $ +.\" $OpenBSD: mdoc.samples.7,v 1.22 2000/03/19 19:25:35 aaron Exp $ .\" $NetBSD: mdoc.samples.7,v 1.5 1996/04/03 20:17:34 jtc Exp $ .\" .\" Copyright (c) 1990, 1993 @@ -73,7 +73,8 @@ page layout macros make up the .Em "page structure domain" which consists of macros for titles, section headers, displays -and lists. Essentially items which affect the physical position +and lists. +Essentially items which affect the physical position of text on a formatted page. In addition to the page structure domain, there are two more domains, the manual domain and the general text domain. @@ -758,8 +759,8 @@ The result is: .Dl Li sptr, ptr), .Pp The punctuation is not recognized and all is output in the -literal font. If the punctuation is separated by a leading -whitespace: +literal font. +If the punctuation is separated by a leading whitespace: .Pp .Dl \&.Li "sptr , ptr ) ," .Pp @@ -1073,7 +1074,8 @@ and may be used with .Ql \&.Fa (function argument) -to get around the limitation. For example: +to get around the limitation. +For example: .Bd -literal -offset indent \&.Fo "int res_mkquery" \&.Fa "int op" @@ -1131,8 +1133,8 @@ section. It may be used anywhere else in the man page without problems, but in the .Sx SYNOPSIS -section it causes a line break after its use. Its main purpose -is to present the function type in kernel normal form +section it causes a line break after its use. +Its main purpose is to present the function type in kernel normal form of a section two or three man page by forcing the function name to appear on the next line. .Pp @@ -1382,7 +1384,8 @@ macro is .Em not parsed and .Em not -callable. It accepts at most two arguments. +callable. +It accepts at most two arguments. .Ss BSD Macro .Dl Usage: .Bx [Version/release] ... \*(Pu .Bl -tag -width ".Bx 4.3 ) ," -compact -offset 14n @@ -1499,7 +1502,8 @@ All handle punctuation properly, as long as it is presented one character at a time and separated by spaces. The quoting macros examine opening and closing punctuation to determine whether it comes before or after the -enclosing string. This makes some nesting possible. +enclosing string. +This makes some nesting possible. .Bl -tag -width xxx,xxxx .It Li \&.Ec , \&.Eo These macros expect the first argument to be the @@ -1511,8 +1515,8 @@ than .Xr nroff . If formatted with .Xr nroff , -a quoted literal is always quoted. If formatted with -troff, an item is only quoted if the width +a quoted literal is always quoted. +If formatted with troff, an item is only quoted if the width of the item is less than three constant width characters. This is to make short strings more visible where the font change to literal (constant width) is less noticeable. @@ -1849,8 +1853,7 @@ The .Sx SYNOPSIS section describes the typical usage of the subject of a man page. -The macros required -are either +The macros required are either .Ql ".Nm" , .Ql ".Cd" , .Ql ".Fn" , @@ -1969,7 +1972,8 @@ macro. Cross references in the .Sx SEE ALSO section should be sorted by section number, and then -placed in alphabetical order and comma separated. For example: +placed in alphabetical order and comma separated. +For example: .Pp .Xr ls 1 , .Xr ps 1 , diff --git a/share/man/man7/operator.7 b/share/man/man7/operator.7 index 76c0c2fc6e5..dd0bd4f582d 100644 --- a/share/man/man7/operator.7 +++ b/share/man/man7/operator.7 @@ -1,3 +1,4 @@ +.\" $OpenBSD: operator.7,v 1.3 2000/03/19 19:25:36 aaron Exp $ .\" $NetBSD: operator.7,v 1.3 1994/11/30 19:07:26 jtc Exp $ .\" .\" Copyright (c) 1989, 1990, 1993 diff --git a/share/man/man7/ports.7 b/share/man/man7/ports.7 index 66585d794c4..7174c3aea5f 100644 --- a/share/man/man7/ports.7 +++ b/share/man/man7/ports.7 @@ -23,7 +23,7 @@ .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF .\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. .\" -.\" $OpenBSD: ports.7,v 1.8 2000/01/29 20:22:30 espie Exp $ +.\" $OpenBSD: ports.7,v 1.9 2000/03/19 19:25:37 aaron Exp $ .\" $FreeBSD: ports.7,v 1.7 1998/06/23 04:38:50 hoek Exp $ .\" .Dd January 25, 1998 @@ -40,15 +40,16 @@ for users and administrators to install applications. Each .Em port contains any patches necessary to make the original -application source code compile and run on BSD. Compiling an -application is as simple as typing +application source code compile and run on BSD. +Compiling an application is as simple as typing .Ic make -in the port directory! The +in the port directory! +The .Pa Makefile automatically fetches the application source code, either from a local disk or via ftp, unpacks it -on the local system, applies the patches, and compiles it. If all goes well, -simply type +on the local system, applies the patches, and compiles it. +If all goes well, simply type .Ic sudo make install to install the application. .Pp @@ -85,18 +86,20 @@ retrieve information relevant to a given port. Individual ports are controlled through a few documented targets. Some of these targets work recursively through subdirectories, so that someone can, for examples, install all of the net -ports. The targets that do this are +ports. +The targets that do this are .Ar build , checksum , clean , configure , extract , fetch , fetch-list , .Ar install , distclean , deinstall, reinstall, mirror-distfiles, obj , .Ar list-distfiles and .Ar package . .Pp -Target names starting with _ are private to the ports infrastructure, +Target names starting with _ are private to the ports infrastructure, should not be invoked directly, and are liable to change without notice. .Pp In the following list, each target will run the preceeding targets -in order automatically. That is, +in order automatically. +That is, .Ar build will be run .Pq if necessary @@ -132,7 +135,8 @@ will skip this step. .It Ar depends Install .Pq or compile if only compilation is necessary -any dependencies of the current port. When called by the +any dependencies of the current port. +When called by the .Ar extract, install or .Ar fetch @@ -148,17 +152,19 @@ Expand the distfile into a work directory. .It Ar patch Apply any patches that are necessary for the port. .It Ar configure -Configure the port. Some ports will ask questions during -this stage. See +Configure the port. +Some ports will ask questions during this stage. +See .Ev INTERACTIVE and .Ev BATCH . .It Ar build -Build the port. This is the same as calling the +Build the port. +This is the same as calling the .Ar all target. .It Ar install -Install the port and register it with the package system. +Install the port and register it with the package system. .El .Pp The following targets are not run during the normal install process. @@ -169,20 +175,23 @@ build the port. .It Ar depends-list package-depends Print an ordered list of all the compile and run dependencies. .It Ar clean -Remove the expanded source code. This does not recurse to dependencies unless +Remove the expanded source code. +This does not recurse to dependencies unless .Ev CLEANDEPENDS is defined to .Dv Yes . .It Ar distclean Remove the port's distfile(s) and perform the .Ar clean -operation. This does not recurse to dependencies. +operation. +This does not recurse to dependencies. .It Ar reinstall Use this to restore a port after using .Xr pkg_delete 1 . .It Ar package -Make a binary package for the port. The port will be installed if it -hasn't already been. The package is a .tgz file that can be used to +Make a binary package for the port. +The port will be installed if it hasn't already been. +The package is a .tgz file that can be used to install the port on other machines with .Xr pkg_add 1 . If the directory specified by @@ -196,7 +205,8 @@ and .Sh PORT VARIABLES These can be changed in the environment, or in .Pa /etc/mk.conf -for persistence. They can also be set on make's command line, e.g., +for persistence. +They can also be set on make's command line, e.g., .Ic make VAR_FOO=foo .Pp Boolean variables should be set to @@ -216,7 +226,8 @@ and edit it. .Pp .Bl -tag -width MASTER_SITES .It Ev PORTSDIR -Location of the ports tree. This is +Location of the ports tree. +This is .Pa /usr/ports on .\" .Fx @@ -285,7 +296,8 @@ recurse to dependencies (deprecated, use .Ev CLEANDEPENDS instead). .It Ev FETCH_CMD -Command to use to fetch files. Normally +Command to use to fetch files. +Normally .Xr fetch 1 . .It Ev FORCE_PKG_REGISTER If set, overwrite any existing package registration on the system. @@ -326,8 +338,10 @@ The FreeBSD handbook. This man page was originated by David O'Brien. The FreeBSD ports collection is maintained by Satoshi Asami -and the awesome ports team. The OpenBSD ports collection has been maintained by -Marco S Hyman in the past. It is currently managed by Christopher Turan, +and the awesome ports team. +The OpenBSD ports collection has been maintained by +Marco S Hyman in the past. +It is currently managed by Christopher Turan, with much help from Brad Smith and a host of others found at ports@openbsd.org. .Sh HISTORY diff --git a/share/man/man7/securelevel.7 b/share/man/man7/securelevel.7 index 99436ee2058..4f0652c7a91 100644 --- a/share/man/man7/securelevel.7 +++ b/share/man/man7/securelevel.7 @@ -1,4 +1,4 @@ -.\" $OpenBSD: securelevel.7,v 1.6 2000/02/27 04:59:10 hugh Exp $ +.\" $OpenBSD: securelevel.7,v 1.7 2000/03/19 19:25:37 aaron Exp $ .\" .\" Copyright (c) 2000 Hugh Graham .\" @@ -67,7 +67,7 @@ and .Pa /dev/kmem may not be written to .It -raw disk devices of mounted filesystems are read-only +raw disk devices of mounted file systems are read-only .It system immutable and append-only file flags may not be removed .It @@ -99,34 +99,40 @@ variables may not be raised .Sh DESCRIPTION Securelevel provides convenient means of .Dq locking down -a system to a degree suited to its environment. It is normally set at -boot via the +a system to a degree suited to its environment. +It is normally set at boot via the .Xr rc.securelevel 8 script, or the superuser may raise securelevel at any time by modifying the .Va kern.securelevel .Xr sysctl 8 -variable. However, only +variable. +However, only .Xr init 8 -may lower it once the system has entered secure mode. A kernel built with -.Dq option INSECURE +may lower it once the system has entered secure mode. +A kernel built with +.Cm option INSECURE in the config file will default to permanently insecure mode. .Pp Highly secure mode may seem Draconian, but is intended as a last line of -defence should the superuser account be compromised. Its effects preclude +defence should the superuser account be compromised. +Its effects preclude circumvention of file flags by direct modification of a raw disk device, -or erasure of a filesystem by means of +or erasure of a file system by means of .Xr newfs 8 . Further, it can limit the potential damage of a compromised .Dq firewall -by prohibiting the modification of packet filter rules. Preventing +by prohibiting the modification of packet filter rules. +Preventing the system clock from being set backwards aids in post-mortem analysis -and helps ensure the integrity of logs. Precision timekeeping is not +and helps ensure the integrity of logs. +Precision timekeeping is not affected because the clock may still be slowed. .Pp Because securelevel can be modified with the in-kernel debugger .Xr ddb 4 , a convenient means of locking it off (if present) is provided -on highly secure systems. This is accomplished by setting +on highly secure systems. +This is accomplished by setting .Va ddb.console and .Va ddb.panic @@ -144,11 +150,10 @@ utility. .Xr init 8 , .Xr rc 8 , .Xr sysctl 8 -.Sh BUGS -The list of securelevel's effects may not be comprehensive. .Sh HISTORY The .Nm manual page first appeared in .Ox 2.6 . - +.Sh BUGS +The list of securelevel's effects may not be comprehensive. |