Remove NetBSD referenced docs
This commit is contained in:
Eirikr Hinngart
parent
5188a03964
commit
50b94a8098
|
|
@ -5,24 +5,18 @@
|
||||||
|
|
||||||
# MINIX:
|
# MINIX:
|
||||||
MAN= \
|
MAN= \
|
||||||
\
|
ifconfig.if.5 \
|
||||||
\
|
|
||||||
hosts.5 ifconfig.if.5 \
|
|
||||||
locale.alias.5 \
|
locale.alias.5 \
|
||||||
\
|
\
|
||||||
\
|
\
|
||||||
\
|
\
|
||||||
nsswitch.conf.5 \
|
resolv.conf.5 \
|
||||||
rc.conf.5 \
|
|
||||||
resolv.conf.5 route.conf.5 \
|
|
||||||
\
|
\
|
||||||
\
|
\
|
||||||
|
|
||||||
|
|
||||||
#MLINKS+=capfile.5 termcap.5
|
#MLINKS+=capfile.5 termcap.5
|
||||||
#MLINKS+=daily.5 daily.conf.5
|
#MLINKS+=daily.5 daily.conf.5
|
||||||
#MLINKS+=fs.5 inode.5
|
#MLINKS+=fs.5 inode.5
|
||||||
#MLINKS+=hosts.equiv.5 rhosts.5
|
|
||||||
#MLINKS+=monthly.5 monthly.conf.5
|
#MLINKS+=monthly.5 monthly.conf.5
|
||||||
MLINKS+=resolv.conf.5 resolver.5
|
MLINKS+=resolv.conf.5 resolver.5
|
||||||
#MLINKS+=utmp.5 wtmp.5 utmp.5 lastlog.5 passwd.5 master.passwd.5
|
#MLINKS+=utmp.5 wtmp.5 utmp.5 lastlog.5 passwd.5 master.passwd.5
|
||||||
|
|
|
||||||
|
|
@ -1,129 +0,0 @@
|
||||||
.\" $NetBSD: hosts.5,v 1.13 2003/08/07 10:31:17 agc Exp $
|
|
||||||
.\"
|
|
||||||
.\" Copyright (c) 1983, 1991, 1993
|
|
||||||
.\" The Regents of the University of California. All rights reserved.
|
|
||||||
.\"
|
|
||||||
.\" Redistribution and use in source and binary forms, with or without
|
|
||||||
.\" modification, are permitted provided that the following conditions
|
|
||||||
.\" are met:
|
|
||||||
.\" 1. Redistributions of source code must retain the above copyright
|
|
||||||
.\" notice, this list of conditions and the following disclaimer.
|
|
||||||
.\" 2. Redistributions in binary form must reproduce the above copyright
|
|
||||||
.\" notice, this list of conditions and the following disclaimer in the
|
|
||||||
.\" documentation and/or other materials provided with the distribution.
|
|
||||||
.\" 3. Neither the name of the University nor the names of its contributors
|
|
||||||
.\" may be used to endorse or promote products derived from this software
|
|
||||||
.\" without specific prior written permission.
|
|
||||||
.\"
|
|
||||||
.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
|
|
||||||
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
|
|
||||||
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
|
|
||||||
.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
|
|
||||||
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
|
|
||||||
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
|
|
||||||
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
|
|
||||||
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
|
|
||||||
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
|
|
||||||
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
|
|
||||||
.\" SUCH DAMAGE.
|
|
||||||
.\"
|
|
||||||
.\" @(#)hosts.5 8.2 (Berkeley) 12/11/93
|
|
||||||
.\"
|
|
||||||
.Dd November 17, 2000
|
|
||||||
.Dt HOSTS 5
|
|
||||||
.Os
|
|
||||||
.Sh NAME
|
|
||||||
.Nm hosts
|
|
||||||
.Nd host name data base
|
|
||||||
.Sh DESCRIPTION
|
|
||||||
The
|
|
||||||
.Nm hosts
|
|
||||||
file contains information regarding the known hosts on the network.
|
|
||||||
It can be used in conjunction with the DNS, and the
|
|
||||||
.Tn NIS
|
|
||||||
maps
|
|
||||||
.Sq hosts.byaddr ,
|
|
||||||
and
|
|
||||||
.Sq hosts.byname ,
|
|
||||||
as controlled by
|
|
||||||
.Xr nsswitch.conf 5 .
|
|
||||||
.Pp
|
|
||||||
For each host a single line should be present
|
|
||||||
with the following information:
|
|
||||||
.Dl address hostname [alias ...]
|
|
||||||
.Pp
|
|
||||||
These are:
|
|
||||||
.Bl -tag -width hostname -compact -offset indent
|
|
||||||
.It Em address
|
|
||||||
Internet address
|
|
||||||
.It Em hostname
|
|
||||||
Official host name
|
|
||||||
.It Em alias
|
|
||||||
Alias host name
|
|
||||||
.El
|
|
||||||
.Pp
|
|
||||||
Items are separated by any number of blanks and/or
|
|
||||||
tab characters. A hash sign
|
|
||||||
.Pq Dq \&#
|
|
||||||
indicates the beginning of
|
|
||||||
a comment; characters up to the end of the line are
|
|
||||||
not interpreted by routines which search the file.
|
|
||||||
.Pp
|
|
||||||
When using the name server
|
|
||||||
.Xr named 8 ,
|
|
||||||
or
|
|
||||||
.Xr ypserv 8 ,
|
|
||||||
this file provides a backup when the name server
|
|
||||||
is not running.
|
|
||||||
For the name server, it is suggested that only a few addresses
|
|
||||||
be included in this file.
|
|
||||||
These include address for the local interfaces that
|
|
||||||
.Xr ifconfig 8
|
|
||||||
needs at boot time and a few machines on the local network.
|
|
||||||
.Pp
|
|
||||||
This file may be created from the official host
|
|
||||||
data base maintained at the Network Information Control
|
|
||||||
Center
|
|
||||||
.Pq Tn NIC ,
|
|
||||||
though local changes may be required
|
|
||||||
to bring it up to date regarding unofficial aliases
|
|
||||||
and/or unknown hosts. As the data base maintained at
|
|
||||||
.Tn NIC
|
|
||||||
is incomplete, use of the name server is recommended for
|
|
||||||
sites on the
|
|
||||||
.Tn DARPA
|
|
||||||
Internet.
|
|
||||||
.Pp
|
|
||||||
As network addresses, both IPv4 and IPv6 addresses are allowed.
|
|
||||||
IPv4 addresses are specified in the conventional dot
|
|
||||||
.Pq Dq \&.
|
|
||||||
notation using the
|
|
||||||
.Xr inet_pton 3
|
|
||||||
routine
|
|
||||||
from the Internet address manipulation library,
|
|
||||||
.Xr inet 3 .
|
|
||||||
IPv6 addresses are specified in the standard hex-and-colon notation.
|
|
||||||
Host names may contain any printable
|
|
||||||
character other than a field delimiter, newline,
|
|
||||||
or comment character.
|
|
||||||
.Sh FILES
|
|
||||||
.Bl -tag -width /etc/hosts -compact
|
|
||||||
.It Pa /etc/hosts
|
|
||||||
The
|
|
||||||
.Nm hosts
|
|
||||||
file resides in
|
|
||||||
.Pa /etc .
|
|
||||||
.El
|
|
||||||
.Sh SEE ALSO
|
|
||||||
.Xr gethostbyname 3 ,
|
|
||||||
.Xr nsswitch.conf 5 ,
|
|
||||||
.Xr ifconfig 8 ,
|
|
||||||
.Xr named 8
|
|
||||||
.Rs
|
|
||||||
.%T "Name Server Operations Guide for BIND"
|
|
||||||
.Re
|
|
||||||
.Sh HISTORY
|
|
||||||
The
|
|
||||||
.Nm
|
|
||||||
file format appeared in
|
|
||||||
.Bx 4.2 .
|
|
||||||
|
|
@ -1,272 +0,0 @@
|
||||||
.\" $NetBSD: nsswitch.conf.5,v 1.28 2009/10/25 01:30:48 wiz Exp $
|
|
||||||
.\"
|
|
||||||
.\" Copyright (c) 1997, 1998, 1999 The NetBSD Foundation, Inc.
|
|
||||||
.\" All rights reserved.
|
|
||||||
.\"
|
|
||||||
.\" This code is derived from software contributed to The NetBSD Foundation
|
|
||||||
.\" by Luke Mewburn.
|
|
||||||
.\"
|
|
||||||
.\" Redistribution and use in source and binary forms, with or without
|
|
||||||
.\" modification, are permitted provided that the following conditions
|
|
||||||
.\" are met:
|
|
||||||
.\" 1. Redistributions of source code must retain the above copyright
|
|
||||||
.\" notice, this list of conditions and the following disclaimer.
|
|
||||||
.\" 2. Redistributions in binary form must reproduce the above copyright
|
|
||||||
.\" notice, this list of conditions and the following disclaimer in the
|
|
||||||
.\" documentation and/or other materials provided with the distribution.
|
|
||||||
.\"
|
|
||||||
.\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
|
|
||||||
.\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
|
|
||||||
.\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
|
|
||||||
.\" PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
|
|
||||||
.\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
|
|
||||||
.\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
|
|
||||||
.\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
|
|
||||||
.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
|
|
||||||
.\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
|
|
||||||
.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
|
|
||||||
.\" POSSIBILITY OF SUCH DAMAGE.
|
|
||||||
.\"
|
|
||||||
.Dd October 25, 2009
|
|
||||||
.Dt NSSWITCH.CONF 5
|
|
||||||
.Os
|
|
||||||
.Sh NAME
|
|
||||||
.Nm nsswitch.conf
|
|
||||||
.Nd name-service switch configuration file
|
|
||||||
.Sh DESCRIPTION
|
|
||||||
The
|
|
||||||
.Nm
|
|
||||||
file specifies how the
|
|
||||||
.Xr nsdispatch 3
|
|
||||||
(name-service switch dispatcher) routines in the C library should operate.
|
|
||||||
.Pp
|
|
||||||
The configuration file controls how a process looks up various databases
|
|
||||||
containing information regarding hosts, users (passwords), groups,
|
|
||||||
netgroups, etc.
|
|
||||||
Each database comes from a source (such as local files, DNS, and
|
|
||||||
.Tn NIS ) ,
|
|
||||||
and the order to look up the sources is specified in
|
|
||||||
.Nm nsswitch.conf .
|
|
||||||
.Pp
|
|
||||||
Each entry in
|
|
||||||
.Nm
|
|
||||||
consists of a database name, and a space separated list of sources.
|
|
||||||
Each source can have an optional trailing criterion that determines
|
|
||||||
whether the next listed source is used, or the search terminates at
|
|
||||||
the current source.
|
|
||||||
Each criterion consists of one or more status codes, and actions to
|
|
||||||
take if that status code occurs.
|
|
||||||
.Ss Sources
|
|
||||||
The following sources are implemented:
|
|
||||||
.Bl -column "multicast_dns" -offset indent -compact
|
|
||||||
.It Sy Source Description
|
|
||||||
.It files Local files, such as
|
|
||||||
.Pa /etc/hosts ,
|
|
||||||
and
|
|
||||||
.Pa /etc/passwd .
|
|
||||||
.It dns Internet Domain Name System.
|
|
||||||
.Dq hosts
|
|
||||||
and
|
|
||||||
.Dq networks
|
|
||||||
use
|
|
||||||
.Sy IN
|
|
||||||
class entries, all other databases use
|
|
||||||
.Sy HS
|
|
||||||
class (Hesiod) entries.
|
|
||||||
.It mdnsd Use
|
|
||||||
.Xr mdnsd 8
|
|
||||||
for
|
|
||||||
.Dq hosts
|
|
||||||
lookups, acting as both a system-wide cache for normal unicast DNS
|
|
||||||
as well as providing multicast DNS
|
|
||||||
.Dq ( zeroconf )
|
|
||||||
lookups.
|
|
||||||
.It multicast_dns Use
|
|
||||||
.Xr mdnsd 8
|
|
||||||
only for multicast DNS
|
|
||||||
.Dq hosts
|
|
||||||
lookups.
|
|
||||||
This would normally be used in conjunction with
|
|
||||||
.Dq dns ,
|
|
||||||
which would then provide unicast DNS resolver functions.
|
|
||||||
.It nis NIS (formerly YP)
|
|
||||||
.It compat support
|
|
||||||
.Sq +/-
|
|
||||||
in the
|
|
||||||
.Dq passwd
|
|
||||||
and
|
|
||||||
.Dq group
|
|
||||||
databases.
|
|
||||||
If this is present, it must be the only source for that entry.
|
|
||||||
.El
|
|
||||||
.Ss Databases
|
|
||||||
The following databases are used by the following C library functions:
|
|
||||||
.Bl -column "netgroup" -offset indent -compact
|
|
||||||
.It Sy Database Used by
|
|
||||||
.It group Ta Xr getgrent 3
|
|
||||||
.It hosts Ta Xr gethostbyname 3
|
|
||||||
.It netgroup Ta Xr getnetgrent 3
|
|
||||||
.It networks Ta Xr getnetbyname 3
|
|
||||||
.It passwd Ta Xr getpwent 3
|
|
||||||
.It shells Ta Xr getusershell 3
|
|
||||||
.El
|
|
||||||
.Ss Status codes
|
|
||||||
The following status codes are available:
|
|
||||||
.Bl -column "tryagain" -offset indent -compact
|
|
||||||
.It Sy Status Description
|
|
||||||
.It success The requested entry was found.
|
|
||||||
.It notfound The entry is not present at this source.
|
|
||||||
.It tryagain The source is busy, and may respond to retries.
|
|
||||||
.It unavail The source is not responding, or entry is corrupt.
|
|
||||||
.El
|
|
||||||
.Ss Actions
|
|
||||||
For each of the status codes, one of two actions is possible:
|
|
||||||
.Bl -column "continue" -offset indent -compact
|
|
||||||
.It Sy Action Description
|
|
||||||
.It continue Try the next source
|
|
||||||
.It return Return with the current result
|
|
||||||
.El
|
|
||||||
.Ss Format of file
|
|
||||||
A
|
|
||||||
.Tn BNF
|
|
||||||
description of the syntax of
|
|
||||||
.Nm
|
|
||||||
is:
|
|
||||||
.Bl -column "\*[Lt]criterion\*[Gt]" -offset indent
|
|
||||||
.It \*[Lt]entry\*[Gt] ::=
|
|
||||||
\*[Lt]database\*[Gt] ":" [\*[Lt]source\*[Gt] [\*[Lt]criteria\*[Gt]]]*
|
|
||||||
.It \*[Lt]criteria\*[Gt] ::=
|
|
||||||
"[" \*[Lt]criterion\*[Gt]+ "]"
|
|
||||||
.It \*[Lt]criterion\*[Gt] ::=
|
|
||||||
\*[Lt]status\*[Gt] "=" \*[Lt]action\*[Gt]
|
|
||||||
.It \*[Lt]status\*[Gt] ::=
|
|
||||||
"success" | "notfound" | "unavail" | "tryagain"
|
|
||||||
.It \*[Lt]action\*[Gt] ::=
|
|
||||||
"return" | "continue"
|
|
||||||
.El
|
|
||||||
.Pp
|
|
||||||
Each entry starts on a new line in the file.
|
|
||||||
A
|
|
||||||
.Sq #
|
|
||||||
delimits a comment to end of line.
|
|
||||||
Blank lines are ignored.
|
|
||||||
A
|
|
||||||
.Sq \e
|
|
||||||
at the end of a line escapes the newline, and causes the next line to
|
|
||||||
be a continuation of the current line.
|
|
||||||
All entries are case-insensitive.
|
|
||||||
.Pp
|
|
||||||
The default criteria is to return on
|
|
||||||
.Dq success ,
|
|
||||||
and continue on anything else (i.e,
|
|
||||||
.Li [success=return notfound=continue unavail=continue tryagain=continue]
|
|
||||||
).
|
|
||||||
.Ss Compat mode: +/- syntax
|
|
||||||
In historical multi-source implementations, the
|
|
||||||
.Sq +
|
|
||||||
and
|
|
||||||
.Sq -
|
|
||||||
characters are used to specify the importing of user password and
|
|
||||||
group information from
|
|
||||||
.Tn NIS .
|
|
||||||
Although
|
|
||||||
.Nm
|
|
||||||
provides alternative methods of accessing distributed sources such as
|
|
||||||
.Tn NIS ,
|
|
||||||
specifying a sole source of
|
|
||||||
.Dq compat
|
|
||||||
will provide the historical behaviour.
|
|
||||||
.Pp
|
|
||||||
An alternative source for the information accessed via
|
|
||||||
.Sq +/-
|
|
||||||
can be used by specifying
|
|
||||||
.Dq passwd_compat: source .
|
|
||||||
.Dq source
|
|
||||||
in this case can be
|
|
||||||
.Sq dns ,
|
|
||||||
.Sq nis ,
|
|
||||||
or
|
|
||||||
any other source except for
|
|
||||||
.Sq files
|
|
||||||
and
|
|
||||||
.Sq compat .
|
|
||||||
.Ss Notes
|
|
||||||
Historically, many of the databases had enumeration functions, often of
|
|
||||||
the form
|
|
||||||
.Fn getXXXent .
|
|
||||||
These made sense when the databases were in local files, but don't make
|
|
||||||
sense or have lesser relevance when there are possibly multiple sources,
|
|
||||||
each of an unknown size.
|
|
||||||
The interfaces are still provided for compatibility, but the source
|
|
||||||
may not be able to provide complete entries, or duplicate entries may
|
|
||||||
be retrieved if multiple sources that contain similar information are
|
|
||||||
specified.
|
|
||||||
.Pp
|
|
||||||
To ensure compatibility with previous and current implementations, the
|
|
||||||
.Dq compat
|
|
||||||
source must appear alone for a given database.
|
|
||||||
.Ss Default source lists
|
|
||||||
If, for any reason,
|
|
||||||
.Nm nsswitch.conf
|
|
||||||
doesn't exist, or it has missing or corrupt entries,
|
|
||||||
.Xr nsdispatch 3
|
|
||||||
will default to an entry of
|
|
||||||
.Dq files
|
|
||||||
for the requested database.
|
|
||||||
Exceptions are:
|
|
||||||
.Bl -column passwd_compat "files dns" -offset indent
|
|
||||||
.It Sy Database Default source list
|
|
||||||
.It group compat
|
|
||||||
.It group_compat nis
|
|
||||||
.It hosts files dns
|
|
||||||
.It netgroup files [notfound=return] nis
|
|
||||||
.It passwd compat
|
|
||||||
.It passwd_compat nis
|
|
||||||
.El
|
|
||||||
.Sh FILES
|
|
||||||
.Bl -tag -width /etc/nsswitch.conf -compact
|
|
||||||
.It Pa /etc/nsswitch.conf
|
|
||||||
The file
|
|
||||||
.Nm
|
|
||||||
resides in
|
|
||||||
.Pa /etc .
|
|
||||||
.El
|
|
||||||
.Sh EXAMPLES
|
|
||||||
To lookup hosts in
|
|
||||||
.Pa /etc/hosts
|
|
||||||
and then from the DNS, and lookup user information from
|
|
||||||
.Tn NIS
|
|
||||||
then files, use:
|
|
||||||
.Bl -column "passwd:" -offset indent
|
|
||||||
.It hosts: files dns
|
|
||||||
.It passwd: nis [notfound=return] files
|
|
||||||
.It group: nis [notfound=return] files
|
|
||||||
.El
|
|
||||||
.Pp
|
|
||||||
The criteria
|
|
||||||
.Dq [notfound=return]
|
|
||||||
sets a policy of "if the user is notfound in nis, don't try files."
|
|
||||||
This treats nis as the authoritative source of information, except
|
|
||||||
when the server is down.
|
|
||||||
.Sh SEE ALSO
|
|
||||||
.Xr getent 1 ,
|
|
||||||
.Xr nsdispatch 3 ,
|
|
||||||
.Xr resolv.conf 5 ,
|
|
||||||
.Xr named 8 ,
|
|
||||||
.Xr ypbind 8
|
|
||||||
.Sh HISTORY
|
|
||||||
The
|
|
||||||
.Nm
|
|
||||||
file format first appeared in
|
|
||||||
.Nx 1.4 .
|
|
||||||
.Sh AUTHORS
|
|
||||||
.An Luke Mewburn
|
|
||||||
.Aq lukem@NetBSD.org
|
|
||||||
wrote this freely distributable name-service switch implementation,
|
|
||||||
using ideas from the
|
|
||||||
.Tn ULTRIX
|
|
||||||
.Xr svc.conf 5
|
|
||||||
and
|
|
||||||
.Tn Solaris
|
|
||||||
.Xr nsswitch.conf 4
|
|
||||||
manual pages.
|
|
||||||
File diff suppressed because it is too large
Load Diff
|
|
@ -1,96 +0,0 @@
|
||||||
.\" $NetBSD: route.conf.5,v 1.5 2012/05/02 22:38:31 wiz Exp $
|
|
||||||
.\"
|
|
||||||
.\" Copyright (c) 2004 Thomas Klausner
|
|
||||||
.\" All rights reserved.
|
|
||||||
.\"
|
|
||||||
.\" Redistribution and use in source and binary forms, with or without
|
|
||||||
.\" modification, are permitted provided that the following conditions
|
|
||||||
.\" are met:
|
|
||||||
.\" 1. Redistributions of source code must retain the above copyright
|
|
||||||
.\" notice, this list of conditions and the following disclaimer.
|
|
||||||
.\" 2. Redistributions in binary form must reproduce the above copyright
|
|
||||||
.\" notice, this list of conditions and the following disclaimer in the
|
|
||||||
.\" documentation and/or other materials provided with the distribution.
|
|
||||||
.\"
|
|
||||||
.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
|
|
||||||
.\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
|
|
||||||
.\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
|
|
||||||
.\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
|
|
||||||
.\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
|
|
||||||
.\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
|
|
||||||
.\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
|
|
||||||
.\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
|
|
||||||
.\" INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
|
|
||||||
.\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
|
||||||
.\"
|
|
||||||
.Dd May 1, 2012
|
|
||||||
.Dt ROUTE.CONF 5
|
|
||||||
.Os
|
|
||||||
.Sh NAME
|
|
||||||
.Nm route.conf
|
|
||||||
.Nd static routes config file
|
|
||||||
.Sh DESCRIPTION
|
|
||||||
The
|
|
||||||
.Nm
|
|
||||||
file is read by the
|
|
||||||
.Pa staticroute
|
|
||||||
rc.d script during system start-up and shutdown,
|
|
||||||
and is intended for adding and removing static routes.
|
|
||||||
.Ss FILE FORMAT
|
|
||||||
Lines starting with a hash
|
|
||||||
.Pq Sq #
|
|
||||||
are comments and ignored.
|
|
||||||
Lines starting with a plus sign
|
|
||||||
.Pq Sq +
|
|
||||||
are run during start-up,
|
|
||||||
while lines starting with a minus sign
|
|
||||||
.Pq Sq \-
|
|
||||||
are run during system shutdown.
|
|
||||||
If a line starts with a
|
|
||||||
.Sq \&! ,
|
|
||||||
the rest of the line will get evaluated as a shell script fragment.
|
|
||||||
All other lines are passed to
|
|
||||||
.Xr route 8 .
|
|
||||||
During start-up, they are passed behind a
|
|
||||||
.Dq Ic route add \-
|
|
||||||
command and during shutdown behind a
|
|
||||||
.Dq Ic route delete \-
|
|
||||||
command.
|
|
||||||
.Sh FILES
|
|
||||||
.Bl -tag -width XXetcXrouteXconfXX
|
|
||||||
.It Pa /etc/route.conf
|
|
||||||
The
|
|
||||||
.Nm
|
|
||||||
file resides in
|
|
||||||
.Pa /etc .
|
|
||||||
.It Pa /etc/rc.d/staticroute
|
|
||||||
.Xr rc.d 8
|
|
||||||
script that parses
|
|
||||||
.Nm .
|
|
||||||
.El
|
|
||||||
.Sh EXAMPLES
|
|
||||||
In this example, the interface for the desired routing changes is set,
|
|
||||||
the IP address on that interface is determined, and a route is added
|
|
||||||
during startup, or deleted during system shutdown.
|
|
||||||
.Bd -literal -offset indent
|
|
||||||
# Set interface and determine current IP address for added route.
|
|
||||||
!ifname=bnx0
|
|
||||||
!ipaddr=$(/sbin/ifconfig ${ifname} | awk '$1 == "inet" {print $2}')
|
|
||||||
net 10.10.1 -interface ${ipaddr}
|
|
||||||
.Ed
|
|
||||||
.Pp
|
|
||||||
In this example,
|
|
||||||
IP forwarding is turned on during
|
|
||||||
start-up, and a static route added for 192.168.2.0.
|
|
||||||
During system shutdown, the route is removed
|
|
||||||
and IP forwarding turned off.
|
|
||||||
.Bd -literal -offset indent
|
|
||||||
# Turn on/off IP forwarding.
|
|
||||||
+sysctl -w net.inet.ip.forwarding=1
|
|
||||||
-sysctl -w net.inet.ip.forwarding=0
|
|
||||||
net 192.168.2.0 -netmask 255.255.255.0 192.168.150.2
|
|
||||||
.Ed
|
|
||||||
.Sh SEE ALSO
|
|
||||||
.Xr rc.conf 5 ,
|
|
||||||
.Xr rc 8 ,
|
|
||||||
.Xr route 8
|
|
||||||
|
|
@ -4,13 +4,7 @@
|
||||||
.include <bsd.init.mk>
|
.include <bsd.init.mk>
|
||||||
|
|
||||||
# missing: eqnchar.7 man.7 ms.7 term.7
|
# missing: eqnchar.7 man.7 ms.7 term.7
|
||||||
|
MAN=
|
||||||
# MINIX:
|
|
||||||
MAN= \
|
|
||||||
nls.7 \
|
|
||||||
\
|
|
||||||
|
|
||||||
|
|
||||||
.if !defined(__MINIX)
|
.if !defined(__MINIX)
|
||||||
CLEANFILES= tests.7
|
CLEANFILES= tests.7
|
||||||
.if ${MKKYUA} != "no"
|
.if ${MKKYUA} != "no"
|
||||||
|
|
|
||||||
|
|
@ -1,518 +0,0 @@
|
||||||
.\" $NetBSD: nls.7,v 1.15 2009/04/09 02:51:54 joerg Exp $
|
|
||||||
.\"
|
|
||||||
.\" Copyright (c) 2003 The NetBSD Foundation, Inc.
|
|
||||||
.\" All rights reserved.
|
|
||||||
.\"
|
|
||||||
.\" This code is derived from software contributed to The NetBSD Foundation
|
|
||||||
.\" by Gregory McGarry.
|
|
||||||
.\"
|
|
||||||
.\" Redistribution and use in source and binary forms, with or without
|
|
||||||
.\" modification, are permitted provided that the following conditions
|
|
||||||
.\" are met:
|
|
||||||
.\" 1. Redistributions of source code must retain the above copyright
|
|
||||||
.\" notice, this list of conditions and the following disclaimer.
|
|
||||||
.\" 2. Redistributions in binary form must reproduce the above copyright
|
|
||||||
.\" notice, this list of conditions and the following disclaimer in the
|
|
||||||
.\" documentation and/or other materials provided with the distribution.
|
|
||||||
.\"
|
|
||||||
.\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
|
|
||||||
.\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
|
|
||||||
.\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
|
|
||||||
.\" PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
|
|
||||||
.\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
|
|
||||||
.\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
|
|
||||||
.\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
|
|
||||||
.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
|
|
||||||
.\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
|
|
||||||
.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
|
|
||||||
.\" POSSIBILITY OF SUCH DAMAGE.
|
|
||||||
.\"
|
|
||||||
.Dd February 21, 2007
|
|
||||||
.Dt NLS 7
|
|
||||||
.Os
|
|
||||||
.Sh NAME
|
|
||||||
.Nm NLS
|
|
||||||
.Nd Native Language Support Overview
|
|
||||||
.Sh DESCRIPTION
|
|
||||||
Native Language Support (NLS) provides commands for a single
|
|
||||||
worldwide operating system base.
|
|
||||||
An internationalized system has no built-in assumptions or dependencies
|
|
||||||
on language-specific or cultural-specific conventions such as:
|
|
||||||
.Pp
|
|
||||||
.Bl -bullet -offset indent -compact
|
|
||||||
.It
|
|
||||||
Character classifications
|
|
||||||
.It
|
|
||||||
Character comparison rules
|
|
||||||
.It
|
|
||||||
Character collation order
|
|
||||||
.It
|
|
||||||
Numeric and monetary formatting
|
|
||||||
.It
|
|
||||||
Date and time formatting
|
|
||||||
.It
|
|
||||||
Message-text language
|
|
||||||
.It
|
|
||||||
Character sets
|
|
||||||
.El
|
|
||||||
.Pp
|
|
||||||
All information pertaining to cultural conventions and language is
|
|
||||||
obtained at program run time.
|
|
||||||
.Pp
|
|
||||||
.Dq Internationalization
|
|
||||||
(often abbreviated
|
|
||||||
.Dq i18n )
|
|
||||||
refers to the operation by which system software is developed to support
|
|
||||||
multiple cultural-specific and language-specific conventions.
|
|
||||||
This is a generalization process by which the system is untied from
|
|
||||||
calling only English strings or other English-specific conventions.
|
|
||||||
.Dq Localization
|
|
||||||
(often abbreviated
|
|
||||||
.Dq l10n )
|
|
||||||
refers to the operations by which the user environment is customized to
|
|
||||||
handle its input and output appropriate for specific language and cultural
|
|
||||||
conventions.
|
|
||||||
This is a specialization process, by which generic methods already
|
|
||||||
implemented in an internationalized system are used in specific ways.
|
|
||||||
The formal description of cultural conventions for some country, together
|
|
||||||
with all associated translations targeted to the native language, is
|
|
||||||
called the
|
|
||||||
.Dq locale .
|
|
||||||
.Pp
|
|
||||||
.Nx
|
|
||||||
provides extensive support to programmers and system developers to
|
|
||||||
enable internationalized software to be developed.
|
|
||||||
.Nx
|
|
||||||
also supplies a large variety of locales for system localization.
|
|
||||||
.Ss Localization of Information
|
|
||||||
All locale information is accessible to programs at run time so that
|
|
||||||
data is processed and displayed correctly for specific cultural
|
|
||||||
conventions and language.
|
|
||||||
.Pp
|
|
||||||
A locale is divided into categories.
|
|
||||||
A category is a group of language-specific and culture-specific conventions
|
|
||||||
as outlined in the list above.
|
|
||||||
ISO C specifies the following six standard categories supported by
|
|
||||||
.Nx :
|
|
||||||
.Pp
|
|
||||||
.Bl -tag -compact -width LC_MONETARYXX
|
|
||||||
.It Ev LC_COLLATE
|
|
||||||
string-collation order information
|
|
||||||
.It Ev LC_CTYPE
|
|
||||||
character classification, case conversion, and other character attributes
|
|
||||||
.It Ev LC_MESSAGES
|
|
||||||
the format for affirmative and negative responses
|
|
||||||
.It Ev LC_MONETARY
|
|
||||||
rules and symbols for formatting monetary numeric information
|
|
||||||
.It Ev LC_NUMERIC
|
|
||||||
rules and symbols for formatting nonmonetary numeric information
|
|
||||||
.It Ev LC_TIME
|
|
||||||
rules and symbols for formatting time and date information
|
|
||||||
.El
|
|
||||||
.Pp
|
|
||||||
Localization of the system is achieved by setting appropriate values
|
|
||||||
in environment variables to identify which locale should be used.
|
|
||||||
The environment variables have the same names as their respective
|
|
||||||
locale categories.
|
|
||||||
Additionally, the
|
|
||||||
.Ev LANG ,
|
|
||||||
.Ev LC_ALL ,
|
|
||||||
and
|
|
||||||
.Ev NLSPATH
|
|
||||||
environment variables are used.
|
|
||||||
The
|
|
||||||
.Ev NLSPATH
|
|
||||||
environment variable specifies a colon-separated list of directory names
|
|
||||||
where the message catalog files of the NLS database are located.
|
|
||||||
The
|
|
||||||
.Ev LC_ALL
|
|
||||||
and
|
|
||||||
.Ev LANG
|
|
||||||
environment variables also determine the current locale.
|
|
||||||
.Pp
|
|
||||||
The values of these environment variables contains a string format as:
|
|
||||||
.Pp
|
|
||||||
.Bd -literal
|
|
||||||
language[_territory][.codeset][@modifier]
|
|
||||||
.Ed
|
|
||||||
.Pp
|
|
||||||
Valid values for the language field come from the ISO639 standard which
|
|
||||||
defines two-character codes for many languages.
|
|
||||||
Some common language codes are:
|
|
||||||
.Pp
|
|
||||||
.Bl -column "PERSIAN (farsi)" "Sy Code" "OCEANIC/INDONESIAN"
|
|
||||||
.It Sy Language Name Ta Sy Code Ta Sy Language Family
|
|
||||||
.It ABKHAZIAN AB IBERO-CAUCASIAN
|
|
||||||
.It AFAN (OROMO) OM HAMITIC
|
|
||||||
.It AFAR AA HAMITIC
|
|
||||||
.It AFRIKAANS AF GERMANIC
|
|
||||||
.It ALBANIAN SQ INDO-EUROPEAN (OTHER)
|
|
||||||
.It AMHARIC AM SEMITIC
|
|
||||||
.It ARABIC AR SEMITIC
|
|
||||||
.It ARMENIAN HY INDO-EUROPEAN (OTHER)
|
|
||||||
.It ASSAMESE AS INDIAN
|
|
||||||
.It AYMARA AY AMERINDIAN
|
|
||||||
.It AZERBAIJANI AZ TURKIC/ALTAIC
|
|
||||||
.It BASHKIR BA TURKIC/ALTAIC
|
|
||||||
.It BASQUE EU BASQUE
|
|
||||||
.It BENGALI BN INDIAN
|
|
||||||
.It BHUTANI DZ ASIAN
|
|
||||||
.It BIHARI BH INDIAN
|
|
||||||
.It BISLAMA Ta BI Ta ""
|
|
||||||
.It BRETON BR CELTIC
|
|
||||||
.It BULGARIAN BG SLAVIC
|
|
||||||
.It BURMESE MY ASIAN
|
|
||||||
.It BYELORUSSIAN BE SLAVIC
|
|
||||||
.It CAMBODIAN KM ASIAN
|
|
||||||
.It CATALAN CA ROMANCE
|
|
||||||
.It CHINESE ZH ASIAN
|
|
||||||
.It CORSICAN CO ROMANCE
|
|
||||||
.It CROATIAN HR SLAVIC
|
|
||||||
.It CZECH CS SLAVIC
|
|
||||||
.It DANISH DA GERMANIC
|
|
||||||
.It DUTCH NL GERMANIC
|
|
||||||
.It ENGLISH EN GERMANIC
|
|
||||||
.It ESPERANTO EO INTERNATIONAL AUX.
|
|
||||||
.It ESTONIAN ET FINNO-UGRIC
|
|
||||||
.It FAROESE FO GERMANIC
|
|
||||||
.It FIJI FJ OCEANIC/INDONESIAN
|
|
||||||
.It FINNISH FI FINNO-UGRIC
|
|
||||||
.It FRENCH FR ROMANCE
|
|
||||||
.It FRISIAN FY GERMANIC
|
|
||||||
.It GALICIAN GL ROMANCE
|
|
||||||
.It GEORGIAN KA IBERO-CAUCASIAN
|
|
||||||
.It GERMAN DE GERMANIC
|
|
||||||
.It GREEK EL LATIN/GREEK
|
|
||||||
.It GREENLANDIC KL ESKIMO
|
|
||||||
.It GUARANI GN AMERINDIAN
|
|
||||||
.It GUJARATI GU INDIAN
|
|
||||||
.It HAUSA HA NEGRO-AFRICAN
|
|
||||||
.It HEBREW HE SEMITIC
|
|
||||||
.It HINDI HI INDIAN
|
|
||||||
.It HUNGARIAN HU FINNO-UGRIC
|
|
||||||
.It ICELANDIC IS GERMANIC
|
|
||||||
.It INDONESIAN ID OCEANIC/INDONESIAN
|
|
||||||
.It INTERLINGUA IA INTERNATIONAL AUX.
|
|
||||||
.It INTERLINGUE IE INTERNATIONAL AUX.
|
|
||||||
.It INUKTITUT Ta IU Ta ""
|
|
||||||
.It INUPIAK IK ESKIMO
|
|
||||||
.It IRISH GA CELTIC
|
|
||||||
.It ITALIAN IT ROMANCE
|
|
||||||
.It JAPANESE JA ASIAN
|
|
||||||
.It JAVANESE JV OCEANIC/INDONESIAN
|
|
||||||
.It KANNADA KN DRAVIDIAN
|
|
||||||
.It KASHMIRI KS INDIAN
|
|
||||||
.It KAZAKH KK TURKIC/ALTAIC
|
|
||||||
.It KINYARWANDA RW NEGRO-AFRICAN
|
|
||||||
.It KIRGHIZ KY TURKIC/ALTAIC
|
|
||||||
.It KURUNDI RN NEGRO-AFRICAN
|
|
||||||
.It KOREAN KO ASIAN
|
|
||||||
.It KURDISH KU IRANIAN
|
|
||||||
.It LAOTHIAN LO ASIAN
|
|
||||||
.It LATIN LA LATIN/GREEK
|
|
||||||
.It LATVIAN LV BALTIC
|
|
||||||
.It LINGALA LN NEGRO-AFRICAN
|
|
||||||
.It LITHUANIAN LT BALTIC
|
|
||||||
.It MACEDONIAN MK SLAVIC
|
|
||||||
.It MALAGASY MG OCEANIC/INDONESIAN
|
|
||||||
.It MALAY MS OCEANIC/INDONESIAN
|
|
||||||
.It MALAYALAM ML DRAVIDIAN
|
|
||||||
.It MALTESE MT SEMITIC
|
|
||||||
.It MAORI MI OCEANIC/INDONESIAN
|
|
||||||
.It MARATHI MR INDIAN
|
|
||||||
.It MOLDAVIAN MO ROMANCE
|
|
||||||
.It MONGOLIAN Ta MN Ta ""
|
|
||||||
.It NAURU Ta NA Ta ""
|
|
||||||
.It NEPALI NE INDIAN
|
|
||||||
.It NORWEGIAN NO GERMANIC
|
|
||||||
.It OCCITAN OC ROMANCE
|
|
||||||
.It ORIYA OR INDIAN
|
|
||||||
.It PASHTO PS IRANIAN
|
|
||||||
.It PERSIAN (farsi) FA IRANIAN
|
|
||||||
.It POLISH PL SLAVIC
|
|
||||||
.It PORTUGUESE PT ROMANCE
|
|
||||||
.It PUNJABI PA INDIAN
|
|
||||||
.It QUECHUA QU AMERINDIAN
|
|
||||||
.It RHAETO-ROMANCE RM ROMANCE
|
|
||||||
.It ROMANIAN RO ROMANCE
|
|
||||||
.It RUSSIAN RU SLAVIC
|
|
||||||
.It SAMOAN SM OCEANIC/INDONESIAN
|
|
||||||
.It SANGHO SG NEGRO-AFRICAN
|
|
||||||
.It SANSKRIT SA INDIAN
|
|
||||||
.It SCOTS GAELIC GD CELTIC
|
|
||||||
.It SERBIAN SR SLAVIC
|
|
||||||
.It SERBO-CROATIAN SH SLAVIC
|
|
||||||
.It SESOTHO ST NEGRO-AFRICAN
|
|
||||||
.It SETSWANA TN NEGRO-AFRICAN
|
|
||||||
.It SHONA SN NEGRO-AFRICAN
|
|
||||||
.It SINDHI SD INDIAN
|
|
||||||
.It SINGHALESE SI INDIAN
|
|
||||||
.It SISWATI SS NEGRO-AFRICAN
|
|
||||||
.It SLOVAK SK SLAVIC
|
|
||||||
.It SLOVENIAN SL SLAVIC
|
|
||||||
.It SOMALI SO HAMITIC
|
|
||||||
.It SPANISH ES ROMANCE
|
|
||||||
.It SUNDANESE SU OCEANIC/INDONESIAN
|
|
||||||
.It SWAHILI SW NEGRO-AFRICAN
|
|
||||||
.It SWEDISH SV GERMANIC
|
|
||||||
.It TAGALOG TL OCEANIC/INDONESIAN
|
|
||||||
.It TAJIK TG IRANIAN
|
|
||||||
.It TAMIL TA DRAVIDIAN
|
|
||||||
.It TATAR TT TURKIC/ALTAIC
|
|
||||||
.It TELUGU TE DRAVIDIAN
|
|
||||||
.It THAI TH ASIAN
|
|
||||||
.It TIBETAN BO ASIAN
|
|
||||||
.It TIGRINYA TI SEMITIC
|
|
||||||
.It TONGA TO OCEANIC/INDONESIAN
|
|
||||||
.It TSONGA TS NEGRO-AFRICAN
|
|
||||||
.It TURKISH TR TURKIC/ALTAIC
|
|
||||||
.It TURKMEN TK TURKIC/ALTAIC
|
|
||||||
.It TWI TW NEGRO-AFRICAN
|
|
||||||
.It UIGUR Ta UG Ta ""
|
|
||||||
.It UKRAINIAN UK SLAVIC
|
|
||||||
.It URDU UR INDIAN
|
|
||||||
.It UZBEK UZ TURKIC/ALTAIC
|
|
||||||
.It VIETNAMESE VI ASIAN
|
|
||||||
.It VOLAPUK VO INTERNATIONAL AUX.
|
|
||||||
.It WELSH CY CELTIC
|
|
||||||
.It WOLOF WO NEGRO-AFRICAN
|
|
||||||
.It XHOSA XH NEGRO-AFRICAN
|
|
||||||
.It YIDDISH YI GERMANIC
|
|
||||||
.It YORUBA YO NEGRO-AFRICAN
|
|
||||||
.It ZHUANG Ta ZA Ta ""
|
|
||||||
.It ZULU ZU NEGRO-AFRICAN
|
|
||||||
.El
|
|
||||||
.Pp
|
|
||||||
For example, the locale for the Danish language spoken in Denmark
|
|
||||||
using the ISO 8859-1 character set is da_DK.ISO8859-1.
|
|
||||||
The da stands for the Danish language and the DK stands for Denmark.
|
|
||||||
The short form of da_DK is sufficient to indicate this locale.
|
|
||||||
.Pp
|
|
||||||
The environment variable settings are queried by their priority level
|
|
||||||
in the following manner:
|
|
||||||
.Pp
|
|
||||||
.Bl -bullet
|
|
||||||
.It
|
|
||||||
If the
|
|
||||||
.Ev LC_ALL
|
|
||||||
environment variable is set, all six categories use the locale it
|
|
||||||
specifies.
|
|
||||||
.It
|
|
||||||
If the
|
|
||||||
.Ev LC_ALL
|
|
||||||
environment variable is not set, each individual category uses the
|
|
||||||
locale specified by its corresponding environment variable.
|
|
||||||
.It
|
|
||||||
If the
|
|
||||||
.Ev LC_ALL
|
|
||||||
environment variable is not set, and a value for a particular
|
|
||||||
.Ev LC_*
|
|
||||||
environment variable is not set, the value of the
|
|
||||||
.Ev LANG
|
|
||||||
environment variable specifies the default locale for all categories.
|
|
||||||
Only the
|
|
||||||
.Ev LANG
|
|
||||||
environment variable should be set in /etc/profile, since it makes it
|
|
||||||
most easy for the user to override the system default using the individual
|
|
||||||
.Ev LC_*
|
|
||||||
variables.
|
|
||||||
.It
|
|
||||||
If the
|
|
||||||
.Ev LC_ALL
|
|
||||||
environment variable is not set, a value for a particular
|
|
||||||
.Ev LC_*
|
|
||||||
environment variable is not set, and the value of the
|
|
||||||
.Ev LANG
|
|
||||||
environment variable is not set, the locale for that specific
|
|
||||||
category defaults to the C locale.
|
|
||||||
The C or POSIX locale assumes the ASCII character set and defines
|
|
||||||
information for the six categories.
|
|
||||||
.El
|
|
||||||
.Ss Character Sets
|
|
||||||
A character is any symbol used for the organization, control, or
|
|
||||||
representation of data.
|
|
||||||
A group of such symbols used to describe a
|
|
||||||
particular language make up a character set.
|
|
||||||
It is the encoding values in a character set that provide
|
|
||||||
the interface between the system and its input and output devices.
|
|
||||||
.Pp
|
|
||||||
The following character sets are supported in
|
|
||||||
.Nx :
|
|
||||||
.Bl -tag -width ISO_8859_family
|
|
||||||
.It ASCII
|
|
||||||
The American Standard Code for Information Exchange (ASCII) standard
|
|
||||||
specifies 128 Roman characters and control codes, encoded in a 7-bit
|
|
||||||
character encoding scheme.
|
|
||||||
.It ISO 8859 family
|
|
||||||
Industry-standard character sets specified by the ISO/IEC 8859
|
|
||||||
standard.
|
|
||||||
The standard is divided into 15 numbered parts, with each
|
|
||||||
part specifying broad script similarities.
|
|
||||||
Examples include Western European, Central European, Arabic, Cyrillic,
|
|
||||||
Hebrew, Greek, and Turkish.
|
|
||||||
The character sets use an 8-bit character encoding scheme which is
|
|
||||||
compatible with the ASCII character set.
|
|
||||||
.It Unicode
|
|
||||||
The Unicode character set is the full set of known abstract characters of
|
|
||||||
all real-world scripts. It can be used in environments where multiple
|
|
||||||
scripts must be processed simultaneously.
|
|
||||||
Unicode is compatible with ISO 8859-1 (Western European) and ASCII.
|
|
||||||
Many character encoding schemes are available for Unicode, including UTF-8,
|
|
||||||
UTF-16 and UTF-32.
|
|
||||||
These encoding schemes are multi-byte encodings.
|
|
||||||
The UTF-8 encoding scheme uses 8-bit, variable-width encodings which is
|
|
||||||
compatible with ASCII.
|
|
||||||
The UTF-16 encoding scheme uses 16-bit, variable-width encodings.
|
|
||||||
The UTF-32 encoding scheme using 32-bit, fixed-width encodings.
|
|
||||||
.El
|
|
||||||
.Ss Font Sets
|
|
||||||
A font set contains the glyphs to be displayed on the screen for a
|
|
||||||
corresponding character in a character set.
|
|
||||||
A display must support a suitable font to display a character set.
|
|
||||||
If suitable fonts are available to the X server, then X clients can
|
|
||||||
include support for different character sets.
|
|
||||||
.Xr xterm 1
|
|
||||||
includes support for Unicode with UTF-8 encoding.
|
|
||||||
.Xr xfd 1
|
|
||||||
is useful for displaying all the characters in an X font.
|
|
||||||
.Pp
|
|
||||||
The
|
|
||||||
.Nx
|
|
||||||
.Xr wscons 4
|
|
||||||
console provides support for loading fonts using the
|
|
||||||
.Xr wsfontload 8
|
|
||||||
utility.
|
|
||||||
Currently, only fonts for the ISO8859-1 family of character sets are
|
|
||||||
supported.
|
|
||||||
.Ss Internationalization for Programmers
|
|
||||||
To facilitate translations of messages into various languages and to
|
|
||||||
make the translated messages available to the program based on a
|
|
||||||
user's locale, it is necessary to keep messages separate from the
|
|
||||||
programs and provide them in the form of message catalogs that a
|
|
||||||
program can access at run time.
|
|
||||||
.Pp
|
|
||||||
Access to locale information is provided through the
|
|
||||||
.Xr setlocale 3
|
|
||||||
and
|
|
||||||
.Xr nl_langinfo 3
|
|
||||||
interfaces.
|
|
||||||
See their respective man pages for further information.
|
|
||||||
.Pp
|
|
||||||
Message source files containing application messages are created by
|
|
||||||
the programmer and converted to message catalogs.
|
|
||||||
These catalogs are used by the application to retrieve and display
|
|
||||||
messages, as needed.
|
|
||||||
.Pp
|
|
||||||
.Nx
|
|
||||||
supports two message catalog interfaces: the X/Open
|
|
||||||
.Xr catgets 3
|
|
||||||
interface and the Uniforum
|
|
||||||
.Xr gettext 3
|
|
||||||
interface.
|
|
||||||
The
|
|
||||||
.Xr catgets 3
|
|
||||||
interface has the advantage that it belongs to a standard which is
|
|
||||||
well supported.
|
|
||||||
Unfortunately the interface is complicated to use and
|
|
||||||
maintenance of the catalogs is difficult.
|
|
||||||
The implementation also doesn't support different character sets.
|
|
||||||
The
|
|
||||||
.Xr gettext 3
|
|
||||||
interface has not been standardized yet, however it is being supported
|
|
||||||
by an increasing number of systems.
|
|
||||||
It also provides many additional tools which make programming and
|
|
||||||
catalog maintenance much easier.
|
|
||||||
.Ss Support for Multi-byte Encodings
|
|
||||||
Some character sets with multi-byte encodings may be difficult to decode,
|
|
||||||
or may contain state (i.e., adjacent characters are dependent).
|
|
||||||
ISO C specifies a set of functions using 'wide characters' which can handle
|
|
||||||
multi-byte encodings properly.
|
|
||||||
The behaviour of these functions is affected
|
|
||||||
by the
|
|
||||||
.Ev LC_CTYPE
|
|
||||||
category of the current locale.
|
|
||||||
.Pp
|
|
||||||
A wide character is specified in ISO C
|
|
||||||
as being a fixed number of bits wide and is stateless.
|
|
||||||
There are two types for wide characters:
|
|
||||||
.Em wchar_t
|
|
||||||
and
|
|
||||||
.Em wint_t .
|
|
||||||
.Em wchar_t
|
|
||||||
is a type which can contain one wide character and operates like 'char'
|
|
||||||
type does for one character.
|
|
||||||
.Em wint_t
|
|
||||||
can contain one wide character or WEOF (wide EOF).
|
|
||||||
.Pp
|
|
||||||
There are functions that operate on
|
|
||||||
.Em wchar_t ,
|
|
||||||
and substitute for functions operating on 'char'.
|
|
||||||
See
|
|
||||||
.Xr wmemchr 3
|
|
||||||
and
|
|
||||||
.Xr towlower 3
|
|
||||||
for details.
|
|
||||||
There are some additional functions that operate on
|
|
||||||
.Em wchar_t .
|
|
||||||
See
|
|
||||||
.Xr wctype 3
|
|
||||||
and
|
|
||||||
.Xr wctrans 3
|
|
||||||
for details.
|
|
||||||
.Pp
|
|
||||||
Wide characters should be used for all I/O processing which may rely
|
|
||||||
on locale-specific strings.
|
|
||||||
The two primary issues requiring special use of wide characters are:
|
|
||||||
.Bl -bullet -offset indent
|
|
||||||
.It
|
|
||||||
All I/O is performed using multibyte characters.
|
|
||||||
Input data is converted into wide characters immediately after
|
|
||||||
reading and data for output is converted from wide characters to
|
|
||||||
multi-byte encoding immediately before writing.
|
|
||||||
Conversion is controlled by the
|
|
||||||
.Xr mbstowcs 3 ,
|
|
||||||
.Xr mbsrtowcs 3 ,
|
|
||||||
.Xr wcstombs 3 ,
|
|
||||||
.Xr wcsrtombs 3 ,
|
|
||||||
.Xr mblen 3 ,
|
|
||||||
.Xr mbrlen 3 ,
|
|
||||||
and
|
|
||||||
.Xr mbsinit 3 .
|
|
||||||
.It
|
|
||||||
Wide characters are used directly for I/O, using
|
|
||||||
.Xr getwchar 3 ,
|
|
||||||
.Xr fgetwc 3 ,
|
|
||||||
.Xr getwc 3 ,
|
|
||||||
.Xr ungetwc 3 ,
|
|
||||||
.Xr fgetws 3 ,
|
|
||||||
.Xr putwchar 3 ,
|
|
||||||
.Xr fputwc 3 ,
|
|
||||||
.Xr putwc 3 ,
|
|
||||||
and
|
|
||||||
.Xr fputws 3 .
|
|
||||||
They are also used for formatted I/O functions for wide characters
|
|
||||||
such as
|
|
||||||
.Xr fwscanf 3 ,
|
|
||||||
.Xr wscanf 3 ,
|
|
||||||
.Xr swscanf 3 ,
|
|
||||||
.Xr fwprintf 3 ,
|
|
||||||
.Xr wprintf 3 ,
|
|
||||||
.Xr swprintf 3 ,
|
|
||||||
.Xr vfwprintf 3 ,
|
|
||||||
.Xr vwprintf 3 ,
|
|
||||||
and
|
|
||||||
.Xr vswprintf 3 ,
|
|
||||||
and wide character identifier of %lc, %C, %ls, %S for conventional
|
|
||||||
formatted I/O functions.
|
|
||||||
.El
|
|
||||||
.Sh SEE ALSO
|
|
||||||
.Xr gencat 1 ,
|
|
||||||
.Xr xfd 1 ,
|
|
||||||
.Xr xterm 1 ,
|
|
||||||
.Xr catgets 3 ,
|
|
||||||
.Xr gettext 3 ,
|
|
||||||
.Xr nl_langinfo 3 ,
|
|
||||||
.Xr setlocale 3 ,
|
|
||||||
.Xr wsfontload 8
|
|
||||||
.Sh BUGS
|
|
||||||
This man page is incomplete.
|
|
||||||
|
|
@ -2,12 +2,7 @@
|
||||||
# from: @(#)Makefile 8.1 (Berkeley) 6/5/93
|
# from: @(#)Makefile 8.1 (Berkeley) 6/5/93
|
||||||
|
|
||||||
# MINIX:
|
# MINIX:
|
||||||
MAN= \
|
MAN=
|
||||||
\
|
|
||||||
\
|
|
||||||
\
|
|
||||||
rc.8 rc.subr.8 \
|
|
||||||
\
|
|
||||||
|
|
||||||
#MLINKS+=MAKEDEV.8 makedev.8
|
#MLINKS+=MAKEDEV.8 makedev.8
|
||||||
#MLINKS+=MAKEDEV.local.8 makedev.local.8
|
#MLINKS+=MAKEDEV.local.8 makedev.local.8
|
||||||
|
|
@ -17,9 +12,6 @@ MAN= \
|
||||||
#MLINKS+=compat_svr4.8 compat_xenix.8
|
#MLINKS+=compat_svr4.8 compat_xenix.8
|
||||||
#MLINKS+=compat_netbsd32.8 netbsd32.8
|
#MLINKS+=compat_netbsd32.8 netbsd32.8
|
||||||
#MLINKS+=nis.8 yp.8
|
#MLINKS+=nis.8 yp.8
|
||||||
MLINKS+=rc.8 rc.d.8
|
|
||||||
MLINKS+=rc.8 rc.local.8
|
|
||||||
MLINKS+=rc.8 rc.shutdown.8
|
|
||||||
|
|
||||||
.if !defined(__MINIX)
|
.if !defined(__MINIX)
|
||||||
SUBDIR= man8.acorn26 man8.acorn32 man8.alpha man8.amiga man8.atari \
|
SUBDIR= man8.acorn26 man8.acorn32 man8.alpha man8.amiga man8.atari \
|
||||||
|
|
|
||||||
|
|
@ -1,381 +0,0 @@
|
||||||
.\" $NetBSD: rc.8,v 1.36 2010/05/14 16:19:58 jruoho Exp $
|
|
||||||
.\"
|
|
||||||
.\" Copyright (c) 2000-2004 The NetBSD Foundation, Inc.
|
|
||||||
.\" All rights reserved.
|
|
||||||
.\"
|
|
||||||
.\" This code is derived from software contributed to The NetBSD Foundation
|
|
||||||
.\" by Luke Mewburn.
|
|
||||||
.\"
|
|
||||||
.\" Redistribution and use in source and binary forms, with or without
|
|
||||||
.\" modification, are permitted provided that the following conditions
|
|
||||||
.\" are met:
|
|
||||||
.\" 1. Redistributions of source code must retain the above copyright
|
|
||||||
.\" notice, this list of conditions and the following disclaimer.
|
|
||||||
.\" 2. Redistributions in binary form must reproduce the above copyright
|
|
||||||
.\" notice, this list of conditions and the following disclaimer in the
|
|
||||||
.\" documentation and/or other materials provided with the distribution.
|
|
||||||
.\"
|
|
||||||
.\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
|
|
||||||
.\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
|
|
||||||
.\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
|
|
||||||
.\" PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
|
|
||||||
.\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
|
|
||||||
.\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
|
|
||||||
.\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
|
|
||||||
.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
|
|
||||||
.\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
|
|
||||||
.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
|
|
||||||
.\" POSSIBILITY OF SUCH DAMAGE.
|
|
||||||
.\"
|
|
||||||
.Dd May 14, 2010
|
|
||||||
.Dt RC 8
|
|
||||||
.Os
|
|
||||||
.Sh NAME
|
|
||||||
.Nm rc ,
|
|
||||||
.Nm rc.local ,
|
|
||||||
.Nm rc.shutdown ,
|
|
||||||
.Nm rc.d/
|
|
||||||
.Nd startup and shutdown scripts
|
|
||||||
.Sh SYNOPSIS
|
|
||||||
.Nm rc
|
|
||||||
.Nm rc.local
|
|
||||||
.Nm rc.shutdown
|
|
||||||
.Nm rc.d/
|
|
||||||
.Sh DESCRIPTION
|
|
||||||
.Nm
|
|
||||||
is the command script which controls the startup of various services,
|
|
||||||
and is invoked by
|
|
||||||
.Xr init 8
|
|
||||||
as part of the process of entering the automatic reboot to multi-user startup,
|
|
||||||
or after the single user mode shell has exited.
|
|
||||||
If
|
|
||||||
.Xr init 8
|
|
||||||
is starting the automatic reboot process,
|
|
||||||
.Nm
|
|
||||||
is invoked with the argument of
|
|
||||||
.Sq autoboot .
|
|
||||||
.Pp
|
|
||||||
.Nm rc.local
|
|
||||||
is a command script to which local boot-time actions can be added.
|
|
||||||
It is (nearly) the last thing invoked by
|
|
||||||
.Nm rc
|
|
||||||
during a normal boot.
|
|
||||||
.Pp
|
|
||||||
.Nm rc.shutdown
|
|
||||||
is the command script which shuts down various services, and is invoked by
|
|
||||||
.Xr shutdown 8
|
|
||||||
as part of the process of shutting down the system.
|
|
||||||
.Pp
|
|
||||||
.Nm rc.d/
|
|
||||||
is the directory which contains various
|
|
||||||
.Xr sh 1
|
|
||||||
scripts, one for each service,
|
|
||||||
which are called by
|
|
||||||
.Nm
|
|
||||||
at startup,
|
|
||||||
.Nm rc.shutdown
|
|
||||||
at shutdown,
|
|
||||||
and as necessary during system operation to stop, start, restart, reload,
|
|
||||||
or otherwise control the service.
|
|
||||||
.Ss Operation of rc
|
|
||||||
.Bl -enum
|
|
||||||
.It
|
|
||||||
Source
|
|
||||||
.Pa /etc/rc.subr
|
|
||||||
to load various
|
|
||||||
.Xr rc.subr 8
|
|
||||||
shell functions to use.
|
|
||||||
.It
|
|
||||||
If autobooting, set
|
|
||||||
.Sy autoboot=yes
|
|
||||||
and enable a flag
|
|
||||||
.Sy ( rc_fast=yes ) ,
|
|
||||||
which prevents the
|
|
||||||
.Nm rc.d
|
|
||||||
scripts from performing the check for already running processes
|
|
||||||
(thus speeding up the boot process).
|
|
||||||
This
|
|
||||||
.Sy rc_fast=yes
|
|
||||||
speedup won't occur when
|
|
||||||
.Nm
|
|
||||||
is started up after exiting the single-user shell.
|
|
||||||
.It
|
|
||||||
Invoke
|
|
||||||
.Xr rcorder 8
|
|
||||||
to order the files in
|
|
||||||
.Pa /etc/rc.d/
|
|
||||||
that do not have a
|
|
||||||
.Dq nostart
|
|
||||||
keyword (refer to
|
|
||||||
.Xr rcorder 8 Ns 's
|
|
||||||
.Fl s
|
|
||||||
flag),
|
|
||||||
and assigns the result to a variable.
|
|
||||||
.It
|
|
||||||
Calls each script in turn using
|
|
||||||
.Fn run_rc_script
|
|
||||||
(from
|
|
||||||
.Xr rc.subr 8 ) ,
|
|
||||||
which sets
|
|
||||||
.Dv $1
|
|
||||||
to
|
|
||||||
.Sq start ,
|
|
||||||
and sources the script in a subshell.
|
|
||||||
If the script has a
|
|
||||||
.Sq .sh
|
|
||||||
suffix then it is sourced directly into the current shell.
|
|
||||||
.It
|
|
||||||
The output from the above steps is sent to a post-processor.
|
|
||||||
If
|
|
||||||
.Sy rc_silent
|
|
||||||
is false, then the post-processor displays the output.
|
|
||||||
If
|
|
||||||
.Sy rc_silent
|
|
||||||
is true, then the post-processor invokes the command specified in
|
|
||||||
.Va rc_silent_cmd
|
|
||||||
once for each line, without otherwise displaying the output.
|
|
||||||
Useful values for
|
|
||||||
.Va rc_silent_cmd
|
|
||||||
include
|
|
||||||
.Dq \&:
|
|
||||||
to display nothing at all, and
|
|
||||||
.Dq twiddle
|
|
||||||
to display a spinning symbol on the console.
|
|
||||||
Regardless of the value of
|
|
||||||
.Sy rc_silent ,
|
|
||||||
the post-processor saves the output in
|
|
||||||
.Pa /var/run/rc.log .
|
|
||||||
.El
|
|
||||||
.Ss Operation of rc.shutdown
|
|
||||||
.Bl -enum
|
|
||||||
.It
|
|
||||||
Source
|
|
||||||
.Pa /etc/rc.subr
|
|
||||||
to load various
|
|
||||||
.Xr rc.subr 8
|
|
||||||
shell functions to use.
|
|
||||||
.It
|
|
||||||
Invoke
|
|
||||||
.Xr rcorder 8
|
|
||||||
to order the files in
|
|
||||||
.Pa /etc/rc.d/
|
|
||||||
that have a
|
|
||||||
.Dq shutdown
|
|
||||||
keyword (refer to
|
|
||||||
.Xr rcorder 8 Ns 's
|
|
||||||
.Fl k
|
|
||||||
flag),
|
|
||||||
reverses that order, and assigns the result to a variable.
|
|
||||||
.It
|
|
||||||
Calls each script in turn using
|
|
||||||
.Fn run_rc_script
|
|
||||||
(from
|
|
||||||
.Xr rc.subr 8 ) ,
|
|
||||||
which sets
|
|
||||||
.Dv $1
|
|
||||||
to
|
|
||||||
.Sq stop ,
|
|
||||||
and sources the script in a subshell.
|
|
||||||
If the script has a
|
|
||||||
.Sq .sh
|
|
||||||
suffix then it is sourced directly into the current shell.
|
|
||||||
.El
|
|
||||||
.Ss Contents of rc.d/
|
|
||||||
.Nm rc.d/
|
|
||||||
is located in
|
|
||||||
.Pa /etc/rc.d .
|
|
||||||
The following file naming conventions are currently used in
|
|
||||||
.Nm rc.d/ :
|
|
||||||
.Bl -tag -width ALLUPPERCASExx -offset indent
|
|
||||||
.It Pa ALLUPPERCASE
|
|
||||||
Scripts that are
|
|
||||||
.Sq placeholders
|
|
||||||
to ensure that certain operations are performed before others.
|
|
||||||
In order of startup, these are:
|
|
||||||
.Bl -tag -width NETWORKINGxx
|
|
||||||
.It Pa NETWORKING
|
|
||||||
Ensure basic network services are running, including general
|
|
||||||
network configuration
|
|
||||||
.Pq Pa network
|
|
||||||
and
|
|
||||||
.Pa dhclient .
|
|
||||||
.It Pa SERVERS
|
|
||||||
Ensure basic services (such as
|
|
||||||
.Pa NETWORKING ,
|
|
||||||
.Pa ppp ,
|
|
||||||
.Pa syslogd ,
|
|
||||||
and
|
|
||||||
.Pa kdc )
|
|
||||||
exist for services that start early (such as
|
|
||||||
.Pa named ) ,
|
|
||||||
because they're required by
|
|
||||||
.Pa DAEMON
|
|
||||||
below.
|
|
||||||
.It Pa DAEMON
|
|
||||||
Before all general purpose daemons such as
|
|
||||||
.Pa dhcpd ,
|
|
||||||
.Pa lpd ,
|
|
||||||
and
|
|
||||||
.Pa ntpd .
|
|
||||||
.It Pa LOGIN
|
|
||||||
Before user login services
|
|
||||||
.Pa ( inetd ,
|
|
||||||
.Pa telnetd ,
|
|
||||||
.Pa rshd ,
|
|
||||||
.Pa sshd ,
|
|
||||||
and
|
|
||||||
.Pa xdm ) ,
|
|
||||||
as well as before services which might run commands as users
|
|
||||||
.Pa ( cron ,
|
|
||||||
.Pa postfix ,
|
|
||||||
and
|
|
||||||
.Pa sendmail ) .
|
|
||||||
.El
|
|
||||||
.It Pa foo.sh
|
|
||||||
Scripts that are to be sourced into the current shell rather than a subshell
|
|
||||||
have a
|
|
||||||
.Sq Pa .sh
|
|
||||||
suffix.
|
|
||||||
Extreme care must be taken in using this, as the startup sequence will
|
|
||||||
terminate if the script does.
|
|
||||||
.Pa /etc/rc.d/bootconf.sh
|
|
||||||
uses this behaviour to allow the user to select a different
|
|
||||||
configuration (including
|
|
||||||
.Pa /etc/rc.conf )
|
|
||||||
early in the boot.
|
|
||||||
.It Pa bar
|
|
||||||
Scripts that are sourced in a subshell.
|
|
||||||
The boot does not stop if such a script terminates with a non-zero status,
|
|
||||||
but a script can stop the boot if necessary by invoking the
|
|
||||||
.Fn stop_boot
|
|
||||||
function (from
|
|
||||||
.Xr rc.subr 8 ) .
|
|
||||||
.El
|
|
||||||
.Pp
|
|
||||||
Each script should contain
|
|
||||||
.Xr rcorder 8
|
|
||||||
keywords, especially an appropriate
|
|
||||||
.Dq PROVIDE
|
|
||||||
entry.
|
|
||||||
.Pp
|
|
||||||
The scripts are expected to support at least the following arguments:
|
|
||||||
.Bl -tag -width restart -offset indent
|
|
||||||
.It Sy start
|
|
||||||
Start the service.
|
|
||||||
This should check that the service is to be started as specified by
|
|
||||||
.Xr rc.conf 5 .
|
|
||||||
Also checks if the service is already running and refuses to start if
|
|
||||||
it is.
|
|
||||||
This latter check is not performed by standard
|
|
||||||
.Nx
|
|
||||||
scripts if the system is starting directly to multi-user mode, to
|
|
||||||
speed up the boot process.
|
|
||||||
.It Sy stop
|
|
||||||
If the service is to be started as specified by
|
|
||||||
.Xr rc.conf 5 ,
|
|
||||||
stop the service.
|
|
||||||
This should check that the service is running and complain if it's not.
|
|
||||||
.It Sy restart
|
|
||||||
Perform a
|
|
||||||
.Sy stop
|
|
||||||
then a
|
|
||||||
.Sy start .
|
|
||||||
.It Sy status
|
|
||||||
If the script starts a process (rather than performing a one-off
|
|
||||||
operation), show the status of the process.
|
|
||||||
Otherwise it's not necessary to support this argument.
|
|
||||||
Defaults to displaying the process ID of the program (if running).
|
|
||||||
.It Sy poll
|
|
||||||
If the script starts a process (rather than performing a one-off
|
|
||||||
operation), wait for the command to exit.
|
|
||||||
Otherwise it's not necessary to support this argument.
|
|
||||||
.It Sy rcvar
|
|
||||||
Display which
|
|
||||||
.Xr rc.conf 5
|
|
||||||
variables are used to control the startup of the service (if any).
|
|
||||||
.El
|
|
||||||
.Pp
|
|
||||||
Other arguments (such as
|
|
||||||
.Sq reload ,
|
|
||||||
.Sq dumpdb ,
|
|
||||||
etc) can be added if necessary.
|
|
||||||
.Pp
|
|
||||||
The argument may have one of the following prefixes to alter its operation:
|
|
||||||
.Bl -tag -width "force" -offset indent
|
|
||||||
.It Sy fast
|
|
||||||
Skip the check for an existing running process.
|
|
||||||
Sets
|
|
||||||
.Sy rc_fast=yes .
|
|
||||||
.It Sy force
|
|
||||||
Skips the
|
|
||||||
.Xr rc.conf 5
|
|
||||||
check, ignores a failure result from any of the prerequisite checks,
|
|
||||||
executes the command, and always returns a zero exit status.
|
|
||||||
Sets
|
|
||||||
.Sy rc_force=yes .
|
|
||||||
.It Sy one
|
|
||||||
Skips the
|
|
||||||
.Xr rc.conf 5
|
|
||||||
check, but performs all other prerequisite tests.
|
|
||||||
.El
|
|
||||||
.Pp
|
|
||||||
In order to simplify scripts, the
|
|
||||||
.Fn run_rc_command
|
|
||||||
function from
|
|
||||||
.Xr rc.subr 8
|
|
||||||
may be used.
|
|
||||||
.Sh FILES
|
|
||||||
.Bl -tag -width /etc/rc.shutdown -compact
|
|
||||||
.It Pa /etc/rc
|
|
||||||
Startup script called by
|
|
||||||
.Xr init 8 .
|
|
||||||
.It Pa /etc/rc.d/
|
|
||||||
Directory containing control scripts for each service.
|
|
||||||
.It Pa /etc/rc.local
|
|
||||||
Local startup script.
|
|
||||||
.It Pa /etc/rc.shutdown
|
|
||||||
Shutdown script called by
|
|
||||||
.Xr shutdown 8 .
|
|
||||||
.It Pa /etc/rc.subr
|
|
||||||
Contains
|
|
||||||
.Xr rc.subr 8
|
|
||||||
functions used by various scripts.
|
|
||||||
.It Pa /etc/rc.conf
|
|
||||||
System startup configuration file.
|
|
||||||
.It Pa /var/run/rc.log
|
|
||||||
Log file created by
|
|
||||||
.Nm .
|
|
||||||
.El
|
|
||||||
.Sh SEE ALSO
|
|
||||||
.Xr rc.conf 5 ,
|
|
||||||
.Xr init 8 ,
|
|
||||||
.Xr rc.subr 8 ,
|
|
||||||
.Xr rcorder 8 ,
|
|
||||||
.Xr reboot 8 ,
|
|
||||||
.Xr shutdown 8
|
|
||||||
.Rs
|
|
||||||
.%A Luke Mewburn
|
|
||||||
.%T The Design and Implementation of the NetBSD rc.d system
|
|
||||||
.%I USENIX Association
|
|
||||||
.%B Proceedings of the FREENIX Track: 2001 USENIX Annual Technical Conference
|
|
||||||
.%D June 25-30, 2001
|
|
||||||
.%U http://www.usenix.org/publications/library/proceedings/usenix01/freenix01/full_papers/mewburn/mewburn.pdf
|
|
||||||
.Re
|
|
||||||
.Sh HISTORY
|
|
||||||
The
|
|
||||||
.Nm
|
|
||||||
command appeared in
|
|
||||||
.Bx 4.0 .
|
|
||||||
The
|
|
||||||
.Pa /etc/rc.d
|
|
||||||
support was implemented in
|
|
||||||
.Nx 1.5
|
|
||||||
by
|
|
||||||
.An Luke Mewburn
|
|
||||||
.Aq lukem@NetBSD.org .
|
|
||||||
The post-processor, support for
|
|
||||||
.Va rc_silent ,
|
|
||||||
and saving output to a file, was implemented in
|
|
||||||
.Nx 6.0
|
|
||||||
by
|
|
||||||
.An Alan Barrett .
|
|
||||||
|
|
@ -1,865 +0,0 @@
|
||||||
.\" $NetBSD: rc.subr.8,v 1.31 2012/12/18 13:14:34 wiz Exp $
|
|
||||||
.\"
|
|
||||||
.\" Copyright (c) 2002-2011 The NetBSD Foundation, Inc.
|
|
||||||
.\" All rights reserved.
|
|
||||||
.\"
|
|
||||||
.\" This code is derived from software contributed to The NetBSD Foundation
|
|
||||||
.\" by Luke Mewburn.
|
|
||||||
.\"
|
|
||||||
.\" Redistribution and use in source and binary forms, with or without
|
|
||||||
.\" modification, are permitted provided that the following conditions
|
|
||||||
.\" are met:
|
|
||||||
.\" 1. Redistributions of source code must retain the above copyright
|
|
||||||
.\" notice, this list of conditions and the following disclaimer.
|
|
||||||
.\" 2. Redistributions in binary form must reproduce the above copyright
|
|
||||||
.\" notice, this list of conditions and the following disclaimer in the
|
|
||||||
.\" documentation and/or other materials provided with the distribution.
|
|
||||||
.\"
|
|
||||||
.\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
|
|
||||||
.\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
|
|
||||||
.\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
|
|
||||||
.\" PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
|
|
||||||
.\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
|
|
||||||
.\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
|
|
||||||
.\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
|
|
||||||
.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
|
|
||||||
.\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
|
|
||||||
.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
|
|
||||||
.\" POSSIBILITY OF SUCH DAMAGE.
|
|
||||||
.\"
|
|
||||||
.Dd December 17, 2012
|
|
||||||
.Dt RC.SUBR 8
|
|
||||||
.Os
|
|
||||||
.Sh NAME
|
|
||||||
.Nm rc.subr
|
|
||||||
.Nd functions used by system shell scripts
|
|
||||||
.Sh SYNOPSIS
|
|
||||||
.Bl -item
|
|
||||||
.It
|
|
||||||
.Li . /etc/rc.subr
|
|
||||||
.It
|
|
||||||
.Ic backup_file Ar action Ar file Ar current Ar backup
|
|
||||||
.It
|
|
||||||
.Ic basename Ar file Op Ar suffix
|
|
||||||
.It
|
|
||||||
.Ic checkyesno Ar var
|
|
||||||
.It
|
|
||||||
.Ic check_pidfile Ar pidfile Ar procname Op Ar interpreter
|
|
||||||
.It
|
|
||||||
.Ic check_process Ar procname Op Ar interpreter
|
|
||||||
.It
|
|
||||||
.Ic collapse_backslash_newline
|
|
||||||
.It
|
|
||||||
.Ic dirname Ar file
|
|
||||||
.It
|
|
||||||
.Ic err Ar exitval Ar message
|
|
||||||
.It
|
|
||||||
.Ic load_rc_config Ar command
|
|
||||||
.It
|
|
||||||
.Ic load_rc_config_var Ar command Ar var
|
|
||||||
.It
|
|
||||||
.Ic mount_critical_filesystems Ar type
|
|
||||||
.It
|
|
||||||
.Ic no_rc_postprocess Ar command Op Ar arguments
|
|
||||||
.It
|
|
||||||
.Ic print_rc_metadata Ar string
|
|
||||||
.It
|
|
||||||
.Ic print_rc_normal Oo Fl n Oc Ar string
|
|
||||||
.It
|
|
||||||
.Ic rc_usage Ar command Op Ar ...
|
|
||||||
.It
|
|
||||||
.Ic reverse_list Ar item Op Ar ...
|
|
||||||
.It
|
|
||||||
.Ic run_rc_command Ar argument [parameters]
|
|
||||||
.It
|
|
||||||
.Ic run_rc_script Ar file Ar argument
|
|
||||||
.It
|
|
||||||
.Ic stop_boot
|
|
||||||
.It
|
|
||||||
.Ic twiddle
|
|
||||||
.It
|
|
||||||
.Ic wait_for_pids Op Ar pid Op Ar ...
|
|
||||||
.It
|
|
||||||
.Ic warn Ar message
|
|
||||||
.It
|
|
||||||
.Ic yesno_to_truefalse Ar var
|
|
||||||
.El
|
|
||||||
.Sh DESCRIPTION
|
|
||||||
.Nm
|
|
||||||
contains commonly used shell script functions which are used by
|
|
||||||
various scripts such as
|
|
||||||
.Xr rc 8 ,
|
|
||||||
and the periodic system services which are controlled by
|
|
||||||
.Xr daily.conf 5 ,
|
|
||||||
.Xr monthly.conf 5 ,
|
|
||||||
.Xr security.conf 5 ,
|
|
||||||
and
|
|
||||||
.Xr weekly.conf 5 .
|
|
||||||
.Pp
|
|
||||||
The
|
|
||||||
.Nm
|
|
||||||
functions are accessed by sourcing
|
|
||||||
.Pa /etc/rc.subr
|
|
||||||
into the current shell.
|
|
||||||
.Pp
|
|
||||||
The following shell functions are available:
|
|
||||||
.Bl -tag -width 4n
|
|
||||||
.It Ic backup_file Ar action Ar file Ar current Ar backup
|
|
||||||
Make a backup copy of
|
|
||||||
.Ar file
|
|
||||||
into
|
|
||||||
.Ar current .
|
|
||||||
If the
|
|
||||||
.Xr rc.conf 5
|
|
||||||
variable
|
|
||||||
.Sy backup_uses_rcs
|
|
||||||
is
|
|
||||||
.Sq YES ,
|
|
||||||
use
|
|
||||||
.Xr rcs 1
|
|
||||||
to archive the previous version of
|
|
||||||
.Ar current ,
|
|
||||||
otherwise save the previous version of
|
|
||||||
.Ar current
|
|
||||||
as
|
|
||||||
.Ar backup .
|
|
||||||
.Pp
|
|
||||||
.Ar action
|
|
||||||
may be one of the following:
|
|
||||||
.Bl -tag -width remove
|
|
||||||
.It Sy add
|
|
||||||
.Ar file
|
|
||||||
is now being backed up by or possibly re-entered into this backup mechanism.
|
|
||||||
.Ar current
|
|
||||||
is created, and if necessary, the
|
|
||||||
.Xr rcs 1
|
|
||||||
files are created as well.
|
|
||||||
.It Sy update
|
|
||||||
.Ar file
|
|
||||||
has changed and needs to be backed up.
|
|
||||||
If
|
|
||||||
.Ar current
|
|
||||||
exists, it is copied to
|
|
||||||
.Ar backup
|
|
||||||
or checked into
|
|
||||||
.Xr rcs 1
|
|
||||||
(if the repository file is old),
|
|
||||||
and then
|
|
||||||
.Ar file
|
|
||||||
is copied to
|
|
||||||
.Ar current .
|
|
||||||
.It Sy remove
|
|
||||||
.Ar file
|
|
||||||
is no longer being tracked by this backup mechanism.
|
|
||||||
If
|
|
||||||
.Xr rcs 1
|
|
||||||
is being used, an empty file is checked in and
|
|
||||||
.Ar current
|
|
||||||
is removed,
|
|
||||||
otherwise
|
|
||||||
.Ar current
|
|
||||||
is moved to
|
|
||||||
.Ar backup .
|
|
||||||
.El
|
|
||||||
.Ic basename Ar file Op Ar suffix
|
|
||||||
Just like
|
|
||||||
.Xr basename 1 ,
|
|
||||||
except implemented using shell built-in commands, and usable before the
|
|
||||||
.Pa /usr/bin
|
|
||||||
direcory is available.
|
|
||||||
.It Ic checkyesno Ar var
|
|
||||||
Return 0 if
|
|
||||||
.Ar var
|
|
||||||
is defined to
|
|
||||||
.Sq YES ,
|
|
||||||
.Sq TRUE ,
|
|
||||||
.Sq ON ,
|
|
||||||
or
|
|
||||||
.Sq 1 .
|
|
||||||
Return 1 if
|
|
||||||
.Ar var
|
|
||||||
is defined to
|
|
||||||
.Sq NO ,
|
|
||||||
.Sq FALSE ,
|
|
||||||
.Sq OFF ,
|
|
||||||
or
|
|
||||||
.Sq 0 .
|
|
||||||
Otherwise, warn that
|
|
||||||
.Ar var
|
|
||||||
is not set correctly.
|
|
||||||
The values are case insensitive.
|
|
||||||
.Pp
|
|
||||||
Note that the warning message shown by this function when
|
|
||||||
.Ar var
|
|
||||||
is not set references a manual page where the user can find more information.
|
|
||||||
Its name is picked up from the
|
|
||||||
.Sy rcvar_manpage
|
|
||||||
variable.
|
|
||||||
.It Ic check_pidfile Ar pidfile Ar procname Op Ar interpreter
|
|
||||||
Parses the first word of the first line of
|
|
||||||
.Ar pidfile
|
|
||||||
for a PID, and ensures that the process with that PID
|
|
||||||
is running and its first argument matches
|
|
||||||
.Ar procname .
|
|
||||||
Prints the matching PID if successful, otherwise nothing.
|
|
||||||
If
|
|
||||||
.Ar interpreter
|
|
||||||
is provided, parse the first line of
|
|
||||||
.Ar procname ,
|
|
||||||
ensure that the line is of the form
|
|
||||||
.Dl #! interpreter [...]
|
|
||||||
and use
|
|
||||||
.Ar interpreter
|
|
||||||
with its optional arguments and
|
|
||||||
.Ar procname
|
|
||||||
appended as the process string to search for.
|
|
||||||
.It Ic check_process Ar procname Op Ar interpreter
|
|
||||||
Prints the PIDs of any processes that are running with a first
|
|
||||||
argument that matches
|
|
||||||
.Ar procname .
|
|
||||||
.Ar interpreter
|
|
||||||
is handled as per
|
|
||||||
.Ic check_pidfile .
|
|
||||||
.It Ic collapse_backslash_newline
|
|
||||||
Copy input to output, collapsing
|
|
||||||
.Ao backslash Ac Ns Ao newline Ac
|
|
||||||
to nothing, but leaving other backslashes alone.
|
|
||||||
.Ic dirname Ar file
|
|
||||||
Just like
|
|
||||||
.Xr dirname 1 ,
|
|
||||||
except implemented using shell built-in commands, and usable before the
|
|
||||||
.Pa /usr/bin
|
|
||||||
direcory is available.
|
|
||||||
.It Ic err Ar exitval Ar message
|
|
||||||
Display an error message to
|
|
||||||
.Em stderr ,
|
|
||||||
log it to the system log
|
|
||||||
using
|
|
||||||
.Xr logger 1 ,
|
|
||||||
and
|
|
||||||
.Cm exit
|
|
||||||
with an exit value of
|
|
||||||
.Ar exitval .
|
|
||||||
The error message consists of the script name
|
|
||||||
(from
|
|
||||||
.Sy $0 ) ,
|
|
||||||
followed by
|
|
||||||
.Dq ": ERROR: " ,
|
|
||||||
and then
|
|
||||||
.Ar message .
|
|
||||||
.It Ic load_rc_config Ar command
|
|
||||||
Source in the
|
|
||||||
.Xr rc.conf 5
|
|
||||||
configuration files for
|
|
||||||
.Ar command .
|
|
||||||
First,
|
|
||||||
.Pa /etc/rc.conf
|
|
||||||
is sourced if it has not yet been read in.
|
|
||||||
Then,
|
|
||||||
.Pa /etc/rc.conf.d/ Ns Ar command
|
|
||||||
is sourced if it is an existing file.
|
|
||||||
The latter may also contain other variable assignments to override
|
|
||||||
.Ic run_rc_command
|
|
||||||
arguments defined by the calling script, to provide an easy
|
|
||||||
mechanism for an administrator to override the behaviour of a given
|
|
||||||
.Xr rc.d 8
|
|
||||||
script without requiring the editing of that script.
|
|
||||||
.It Ic load_rc_config_var Ar command Ar var
|
|
||||||
Read the
|
|
||||||
.Xr rc.conf 5
|
|
||||||
variable
|
|
||||||
.Ar var
|
|
||||||
for
|
|
||||||
.Ar command
|
|
||||||
and set in the current shell, using
|
|
||||||
.Ic load_rc_config
|
|
||||||
in a sub-shell to prevent unwanted side effects from other variable
|
|
||||||
assignments.
|
|
||||||
.It Ic mount_critical_filesystems Ar type
|
|
||||||
Go through a list of critical file systems,
|
|
||||||
as found in the
|
|
||||||
.Xr rc.conf 5
|
|
||||||
variable
|
|
||||||
.Sy critical_filesystems_ Ns Ar type ,
|
|
||||||
mounting each one that
|
|
||||||
is not currently mounted.
|
|
||||||
.It Ic no_rc_postprocess Ar command Op Ar arguments
|
|
||||||
Execute the specified command with the specified arguments,
|
|
||||||
in such a way that its output bypasses the post-processor that
|
|
||||||
.Xr rc 8
|
|
||||||
uses for most commands.
|
|
||||||
This implies that the output will not appear in the
|
|
||||||
.Pa /var/run/rc.log
|
|
||||||
file, and will appear on the console regardless of the
|
|
||||||
value of
|
|
||||||
.Va rc_silent .
|
|
||||||
This is expected to be useful for interactive commands,
|
|
||||||
and this mechanism is automatically used by
|
|
||||||
.Ic run_rc_command
|
|
||||||
when a script contains the
|
|
||||||
.Xr rcorder 8
|
|
||||||
keyword
|
|
||||||
.Dq interactive .
|
|
||||||
.Pp
|
|
||||||
If invoked from a context that does not appear to be under the control of
|
|
||||||
.Xr rc 8 ,
|
|
||||||
then the command is executed without special treatment.
|
|
||||||
.It Ic print_rc_metadata Ar string
|
|
||||||
Print the specified
|
|
||||||
.Ar string
|
|
||||||
in such a way that it should be handled as meta-data by the
|
|
||||||
.Xr rc 8
|
|
||||||
post-processor.
|
|
||||||
If invoked from a context that does not appear to be under the control of
|
|
||||||
.Xr rc 8 ,
|
|
||||||
then the
|
|
||||||
.Ar string
|
|
||||||
is discarded.
|
|
||||||
.Pp
|
|
||||||
Any
|
|
||||||
.Xr rc.d 8
|
|
||||||
script may invoke this function with an argument that begins with
|
|
||||||
.Dq note: ,
|
|
||||||
followed by one line of arbitrary text;
|
|
||||||
the text will be logged by
|
|
||||||
.Xr rc 8
|
|
||||||
but will not be displayed on the console.
|
|
||||||
.Pp
|
|
||||||
The use of arguments that do not begin with
|
|
||||||
.Dq note:
|
|
||||||
is reserved for internal use by
|
|
||||||
.Xr rc 8
|
|
||||||
and
|
|
||||||
.Nm .
|
|
||||||
.It Ic print_rc_normal Oo Fl n Oc Ar string
|
|
||||||
Print the specified
|
|
||||||
.Ar string
|
|
||||||
in such a way that it should be handled as normal output by the
|
|
||||||
.Xr rc 8
|
|
||||||
post-processor.
|
|
||||||
If invoked from a context that does not appear to be under the control of
|
|
||||||
.Xr rc 8 ,
|
|
||||||
then the
|
|
||||||
.Ar string
|
|
||||||
is printed to standard output.
|
|
||||||
.Pp
|
|
||||||
If the
|
|
||||||
.Fl n
|
|
||||||
flag is specified, then the string is printed without a newline.
|
|
||||||
.Pp
|
|
||||||
Intended use cases include:
|
|
||||||
.Bl -bullet
|
|
||||||
.It
|
|
||||||
An rc.d script can use
|
|
||||||
.Dq Sy print_rc_normal Fl n
|
|
||||||
to print a partial line in such a way that it appears
|
|
||||||
immediately instead of being buffered by
|
|
||||||
.Xr rc 8 Ap s
|
|
||||||
post-processor.
|
|
||||||
.It
|
|
||||||
An rc.d script that is run via the
|
|
||||||
.Sy no_rc_postprocess
|
|
||||||
function (so most of its output is invisible to
|
|
||||||
.Xr rc 8 Ap s
|
|
||||||
post-processor) can use
|
|
||||||
.Sy print_rc_normal
|
|
||||||
to force some of its output to be seen by the post-processor.
|
|
||||||
.El
|
|
||||||
.It Ic rc_usage Ar command Op Ar ...
|
|
||||||
Print a usage message for
|
|
||||||
.Sy $0 ,
|
|
||||||
with
|
|
||||||
.Ar commands
|
|
||||||
being the list of valid arguments
|
|
||||||
prefixed by
|
|
||||||
.Dq "[fast|force|one]" .
|
|
||||||
.It Ic reverse_list Ar item Op Ar ...
|
|
||||||
Print the list of
|
|
||||||
.Ar items
|
|
||||||
in reverse order.
|
|
||||||
.It Ic run_rc_command Ar argument Op Ar parameter ...
|
|
||||||
Run the
|
|
||||||
.Ar argument
|
|
||||||
method for the current
|
|
||||||
.Xr rc.d 8
|
|
||||||
script, based on the settings of various shell variables.
|
|
||||||
.Ic run_rc_command
|
|
||||||
is extremely flexible, and allows fully functional
|
|
||||||
.Xr rc.d 8
|
|
||||||
scripts to be implemented in a small amount of shell code.
|
|
||||||
The optional set of parameters is passed verbatim to the command, but not to its
|
|
||||||
pre/post hooks.
|
|
||||||
.Pp
|
|
||||||
.Ar argument
|
|
||||||
is searched for in the list of supported commands, which may be one
|
|
||||||
of:
|
|
||||||
.Bl -tag -width restart -offset indent
|
|
||||||
.It Sy start
|
|
||||||
Start the service.
|
|
||||||
This should check that the service is to be started as specified by
|
|
||||||
.Xr rc.conf 5 .
|
|
||||||
Also checks if the service is already running and refuses to start if
|
|
||||||
it is.
|
|
||||||
This latter check is not performed by standard
|
|
||||||
.Nx
|
|
||||||
scripts if the system is starting directly to multi-user mode, to
|
|
||||||
speed up the boot process.
|
|
||||||
.It Sy stop
|
|
||||||
If the service is to be started as specified by
|
|
||||||
.Xr rc.conf 5 ,
|
|
||||||
stop the service.
|
|
||||||
This should check that the service is running and complain if it's not.
|
|
||||||
.It Sy restart
|
|
||||||
Perform a
|
|
||||||
.Sy stop
|
|
||||||
then a
|
|
||||||
.Sy start .
|
|
||||||
Defaults to displaying the process ID of the program (if running).
|
|
||||||
.It Sy rcvar
|
|
||||||
Display which
|
|
||||||
.Xr rc.conf 5
|
|
||||||
variables are used to control the startup of the service (if any).
|
|
||||||
.El
|
|
||||||
.Pp
|
|
||||||
If
|
|
||||||
.Sy pidfile
|
|
||||||
or
|
|
||||||
.Sy procname
|
|
||||||
is set, also support:
|
|
||||||
.Bl -tag -width restart -offset indent
|
|
||||||
.It Sy poll
|
|
||||||
Wait for the command to exit.
|
|
||||||
.It Sy status
|
|
||||||
Show the status of the process.
|
|
||||||
.El
|
|
||||||
.Pp
|
|
||||||
Other supported commands are listed in the optional variable
|
|
||||||
.Sy extra_commands .
|
|
||||||
.Pp
|
|
||||||
.Ar argument
|
|
||||||
may have one of the following prefixes which alters its operation:
|
|
||||||
.Bl -tag -width "Prefix" -offset indent
|
|
||||||
.It Sy fast
|
|
||||||
Skip the check for an existing running process,
|
|
||||||
and sets
|
|
||||||
.Sy rc_fast=YES .
|
|
||||||
.It Sy force
|
|
||||||
Skip the checks for
|
|
||||||
.Sy rcvar
|
|
||||||
being set to yes,
|
|
||||||
and sets
|
|
||||||
.Sy rc_force=YES .
|
|
||||||
This ignores
|
|
||||||
.Ar argument Ns Sy _precmd
|
|
||||||
returning non-zero, and ignores any of the
|
|
||||||
.Sy required_*
|
|
||||||
tests failing, and always returns a zero exit status.
|
|
||||||
.It Sy one
|
|
||||||
Skip the checks for
|
|
||||||
.Sy rcvar
|
|
||||||
being set to yes, but performs all the other prerequisite tests.
|
|
||||||
.El
|
|
||||||
.Pp
|
|
||||||
.Ic run_rc_command
|
|
||||||
uses the following shell variables to control its behaviour.
|
|
||||||
Unless otherwise stated, these are optional.
|
|
||||||
.Bl -tag -width procname -offset indent
|
|
||||||
.It Sy name
|
|
||||||
The name of this script.
|
|
||||||
This is not optional.
|
|
||||||
.It Sy rcvar
|
|
||||||
The value of
|
|
||||||
.Sy rcvar
|
|
||||||
is checked with
|
|
||||||
.Ic checkyesno
|
|
||||||
to determine if this method should be run.
|
|
||||||
.It Sy rcvar_manpage
|
|
||||||
The manual page containing information about
|
|
||||||
.Sy rcvar .
|
|
||||||
It will be part of the warning message shown when
|
|
||||||
.Sy rcvar
|
|
||||||
is undefined.
|
|
||||||
Defaults to
|
|
||||||
.Xr rc.conf 5 .
|
|
||||||
.It Sy command
|
|
||||||
Full path to the command.
|
|
||||||
Not required if
|
|
||||||
.Ar argument Ns Sy _cmd
|
|
||||||
is defined for each supported keyword.
|
|
||||||
.It Sy command_args
|
|
||||||
Optional arguments and/or shell directives for
|
|
||||||
.Sy command .
|
|
||||||
.It Sy command_interpreter
|
|
||||||
.Sy command
|
|
||||||
is started with
|
|
||||||
.Dl #! command_interpreter [...]
|
|
||||||
which results in its
|
|
||||||
.Xr ps 1
|
|
||||||
command being
|
|
||||||
.Dl command_interpreter [...] command
|
|
||||||
so use that string to find the PID(s) of the running command
|
|
||||||
rather than
|
|
||||||
.Ql command .
|
|
||||||
.It Sy extra_commands
|
|
||||||
Extra commands/keywords/arguments supported.
|
|
||||||
.It Sy pidfile
|
|
||||||
Path to pid file.
|
|
||||||
Used to determine the PID(s) of the running command.
|
|
||||||
If
|
|
||||||
.Sy pidfile
|
|
||||||
is set, use
|
|
||||||
.Dl check_pidfile $pidfile $procname
|
|
||||||
to find the PID.
|
|
||||||
Otherwise, if
|
|
||||||
.Sy command
|
|
||||||
is set, use
|
|
||||||
.Dl check_process $procname
|
|
||||||
to find the PID.
|
|
||||||
.It Sy procname
|
|
||||||
Process name to check for.
|
|
||||||
Defaults to the value of
|
|
||||||
.Sy command .
|
|
||||||
.It Sy required_dirs
|
|
||||||
Check for the existence of the listed directories
|
|
||||||
before running the default start method.
|
|
||||||
.It Sy required_files
|
|
||||||
Check for the readability of the listed files
|
|
||||||
before running the default start method.
|
|
||||||
.It Sy required_vars
|
|
||||||
Perform
|
|
||||||
.Ic checkyesno
|
|
||||||
on each of the list variables
|
|
||||||
before running the default start method.
|
|
||||||
.It Sy ${name}_chdir
|
|
||||||
Directory to
|
|
||||||
.Ic cd
|
|
||||||
to before running
|
|
||||||
.Sy command ,
|
|
||||||
if
|
|
||||||
.Sy ${name}_chroot
|
|
||||||
is not provided.
|
|
||||||
.It Sy ${name}_chroot
|
|
||||||
Directory to
|
|
||||||
.Xr chroot 8
|
|
||||||
to before running
|
|
||||||
.Sy command .
|
|
||||||
Only supported after
|
|
||||||
.Pa /usr
|
|
||||||
is mounted.
|
|
||||||
.It Sy ${name}_env
|
|
||||||
List of additional or modified environment variables to set
|
|
||||||
when starting
|
|
||||||
.Sy command .
|
|
||||||
.It Sy ${name}_flags
|
|
||||||
Arguments to call
|
|
||||||
.Sy command
|
|
||||||
with.
|
|
||||||
This is usually set in
|
|
||||||
.Xr rc.conf 5 ,
|
|
||||||
and not in the
|
|
||||||
.Xr rc.d 8
|
|
||||||
script.
|
|
||||||
The environment variable
|
|
||||||
.Sq Ev flags
|
|
||||||
can be used to override this.
|
|
||||||
.It Sy ${name}_nice
|
|
||||||
.Xr nice 1
|
|
||||||
level to run
|
|
||||||
.Sy command
|
|
||||||
as.
|
|
||||||
Only supported after
|
|
||||||
.Pa /usr
|
|
||||||
is mounted.
|
|
||||||
.It Sy ${name}_user
|
|
||||||
User to run
|
|
||||||
.Sy command
|
|
||||||
as, using
|
|
||||||
.Xr chroot 8 .
|
|
||||||
if
|
|
||||||
.Sy ${name}_chroot
|
|
||||||
is set, otherwise
|
|
||||||
uses
|
|
||||||
.Xr su 1 .
|
|
||||||
Only supported after
|
|
||||||
.Pa /usr
|
|
||||||
is mounted.
|
|
||||||
.It Sy ${name}_group
|
|
||||||
Group to run the chrooted
|
|
||||||
.Sy command
|
|
||||||
as.
|
|
||||||
.It Sy ${name}_groups
|
|
||||||
Comma separated list of supplementary groups to run the chrooted
|
|
||||||
.Sy command
|
|
||||||
with.
|
|
||||||
.It Ar argument Ns Sy _cmd
|
|
||||||
Shell commands which override the default method for
|
|
||||||
.Ar argument .
|
|
||||||
.It Ar argument Ns Sy _precmd
|
|
||||||
Shell commands to run just before running
|
|
||||||
.Ar argument Ns Sy _cmd
|
|
||||||
or the default method for
|
|
||||||
.Ar argument .
|
|
||||||
If this returns a non-zero exit code, the main method is not performed.
|
|
||||||
If the default method is being executed, this check is performed after
|
|
||||||
the
|
|
||||||
.Sy required_*
|
|
||||||
checks and process (non-)existence checks.
|
|
||||||
.It Ar argument Ns Sy _postcmd
|
|
||||||
Shell commands to run if running
|
|
||||||
.Ar argument Ns Sy _cmd
|
|
||||||
or the default method for
|
|
||||||
.Ar argument
|
|
||||||
returned a zero exit code.
|
|
||||||
.It Sy sig_stop
|
|
||||||
Signal to send the processes to stop in the default
|
|
||||||
.Sy stop
|
|
||||||
method.
|
|
||||||
Defaults to
|
|
||||||
.Dv SIGTERM .
|
|
||||||
.It Sy sig_reload
|
|
||||||
Signal to send the processes to reload in the default
|
|
||||||
.Sy reload
|
|
||||||
method.
|
|
||||||
Defaults to
|
|
||||||
.Dv SIGHUP .
|
|
||||||
.El
|
|
||||||
.Pp
|
|
||||||
For a given method
|
|
||||||
.Ar argument ,
|
|
||||||
if
|
|
||||||
.Ar argument Ns Sy _cmd
|
|
||||||
is not defined, then a default method is provided by
|
|
||||||
.Sy run_rc_command :
|
|
||||||
.Bl -tag -width "argument" -offset indent
|
|
||||||
.It Sy Argument
|
|
||||||
.Sy Default method
|
|
||||||
.It Sy start
|
|
||||||
If
|
|
||||||
.Sy command
|
|
||||||
is not running and
|
|
||||||
.Ic checkyesno Sy rcvar
|
|
||||||
succeeds, start
|
|
||||||
.Sy command .
|
|
||||||
.It Sy stop
|
|
||||||
Determine the PIDs of
|
|
||||||
.Sy command
|
|
||||||
with
|
|
||||||
.Ic check_pidfile
|
|
||||||
or
|
|
||||||
.Ic check_process
|
|
||||||
(as appropriate),
|
|
||||||
.Ic kill Sy sig_stop
|
|
||||||
those PIDs, and run
|
|
||||||
.Ic wait_for_pids
|
|
||||||
on those PIDs.
|
|
||||||
.It Sy reload
|
|
||||||
Similar to
|
|
||||||
.Sy stop ,
|
|
||||||
except that it uses
|
|
||||||
.Sy sig_reload
|
|
||||||
instead, and doesn't run
|
|
||||||
.Ic wait_for_pids .
|
|
||||||
.It Sy restart
|
|
||||||
Runs the
|
|
||||||
.Sy stop
|
|
||||||
method, then the
|
|
||||||
.Sy start
|
|
||||||
method.
|
|
||||||
.It Sy status
|
|
||||||
Show the PID of
|
|
||||||
.Sy command ,
|
|
||||||
or some other script specific status operation.
|
|
||||||
.It Sy poll
|
|
||||||
Wait for
|
|
||||||
.Sy command
|
|
||||||
to exit.
|
|
||||||
.It Sy rcvar
|
|
||||||
Display which
|
|
||||||
.Xr rc.conf 5
|
|
||||||
variable is used (if any).
|
|
||||||
This method always works, even if the appropriate
|
|
||||||
.Xr rc.conf 5
|
|
||||||
variable is set to
|
|
||||||
.Sq NO .
|
|
||||||
.El
|
|
||||||
.Pp
|
|
||||||
The following variables are available to the methods
|
|
||||||
(such as
|
|
||||||
.Ar argument Ns Sy _cmd )
|
|
||||||
as well as after
|
|
||||||
.Ic run_rc_command
|
|
||||||
has completed:
|
|
||||||
.Bl -tag -width "rc_flags" -offset indent
|
|
||||||
.It Sy rc_arg
|
|
||||||
Argument provided to
|
|
||||||
.Sy run_rc_command ,
|
|
||||||
after fast and force processing has been performed.
|
|
||||||
.It Sy rc_flags
|
|
||||||
Flags to start the default command with.
|
|
||||||
Defaults to
|
|
||||||
.Sy ${name}_flags ,
|
|
||||||
unless overridden by the environment variable
|
|
||||||
.Sq Ev flags .
|
|
||||||
This variable may be changed by the
|
|
||||||
.Ar argument Ns Sy _precmd
|
|
||||||
method.
|
|
||||||
.It Sy rc_pid
|
|
||||||
PID of
|
|
||||||
.Sy command
|
|
||||||
(if appropriate).
|
|
||||||
.It Sy rc_fast
|
|
||||||
Not empty if
|
|
||||||
.Dq fast
|
|
||||||
prefix was used.
|
|
||||||
.It Sy rc_force
|
|
||||||
Not empty if
|
|
||||||
.Dq force
|
|
||||||
prefix was used.
|
|
||||||
.El
|
|
||||||
.It Ic run_rc_script Ar file Ar argument
|
|
||||||
Start the script
|
|
||||||
.Ar file
|
|
||||||
with an argument of
|
|
||||||
.Ar argument ,
|
|
||||||
and handle the return value from the script.
|
|
||||||
.Pp
|
|
||||||
Various shell variables are unset before
|
|
||||||
.Ar file
|
|
||||||
is started:
|
|
||||||
.Bd -ragged -offset indent
|
|
||||||
.Sy name ,
|
|
||||||
.Sy command ,
|
|
||||||
.Sy command_args ,
|
|
||||||
.Sy command_interpreter ,
|
|
||||||
.Sy extra_commands ,
|
|
||||||
.Sy pidfile ,
|
|
||||||
.Sy rcvar ,
|
|
||||||
.Sy required_dirs ,
|
|
||||||
.Sy required_files ,
|
|
||||||
.Sy required_vars ,
|
|
||||||
.Ar argument Ns Sy _cmd ,
|
|
||||||
.Ar argument Ns Sy _precmd .
|
|
||||||
.Ar argument Ns Sy _postcmd .
|
|
||||||
.Ed
|
|
||||||
.Pp
|
|
||||||
The startup behaviour of
|
|
||||||
.Ar file
|
|
||||||
depends upon the following checks:
|
|
||||||
.Bl -enum
|
|
||||||
.It
|
|
||||||
If
|
|
||||||
.Ar file
|
|
||||||
ends in
|
|
||||||
.Pa .sh ,
|
|
||||||
it is sourced into the current shell.
|
|
||||||
.It
|
|
||||||
If
|
|
||||||
.Ar file
|
|
||||||
appears to be a backup or scratch file
|
|
||||||
(e.g., with a suffix of
|
|
||||||
.Sq ~ ,
|
|
||||||
.Sq # ,
|
|
||||||
.Sq .OLD ,
|
|
||||||
or
|
|
||||||
.Sq .orig ) ,
|
|
||||||
ignore it.
|
|
||||||
.It
|
|
||||||
If
|
|
||||||
.Ar file
|
|
||||||
is not executable, ignore it.
|
|
||||||
.It
|
|
||||||
If the
|
|
||||||
.Xr rc.conf 5
|
|
||||||
variable
|
|
||||||
.Sy rc_fast_and_loose
|
|
||||||
is empty,
|
|
||||||
source
|
|
||||||
.Ar file
|
|
||||||
in a sub shell,
|
|
||||||
otherwise source
|
|
||||||
.Ar file
|
|
||||||
into the current shell.
|
|
||||||
.It
|
|
||||||
If
|
|
||||||
.Ar file
|
|
||||||
contains the
|
|
||||||
.Xr rcorder 8
|
|
||||||
keyword
|
|
||||||
.Dq interactive ,
|
|
||||||
then the command is executed using
|
|
||||||
.Ic no_rc_postprocess .
|
|
||||||
.El
|
|
||||||
.It Ic stop_boot
|
|
||||||
Prevent booting to multiuser mode.
|
|
||||||
If the
|
|
||||||
.Sy autoboot
|
|
||||||
variable is
|
|
||||||
.Sq yes ,
|
|
||||||
then a
|
|
||||||
.Sy SIGTERM
|
|
||||||
signal is sent to the parent
|
|
||||||
process (which is assumed to be
|
|
||||||
.Xr rc 8 ) .
|
|
||||||
Otherwise, the shell exits with status
|
|
||||||
.Li 1 .
|
|
||||||
.It Ic twiddle
|
|
||||||
Display one of the characters
|
|
||||||
.Sq \&/ , \&- , \&\e , \&| ,
|
|
||||||
followed by a backspace.
|
|
||||||
Repeated calls to this function will create the appearance of a spinning
|
|
||||||
symbol, as a different character is displayed on each call.
|
|
||||||
Output is to
|
|
||||||
.Pa /dev/tty ,
|
|
||||||
so this function may be useful even inside a script whose output
|
|
||||||
has been redirected.
|
|
||||||
.It Ic wait_for_pids Op Ar pid Op Ar ...
|
|
||||||
Wait until all of the provided
|
|
||||||
.Ar pids
|
|
||||||
don't exist any more, printing the list of outstanding
|
|
||||||
.Ar pids
|
|
||||||
every two seconds.
|
|
||||||
.It Ic warn Ar message
|
|
||||||
Display a warning message to
|
|
||||||
.Em stderr
|
|
||||||
and log it to the system log
|
|
||||||
using
|
|
||||||
.Xr logger 1 .
|
|
||||||
The warning message consists of the script name
|
|
||||||
(from
|
|
||||||
.Sy $0 ) ,
|
|
||||||
followed by
|
|
||||||
.Dq ": WARNING: " ,
|
|
||||||
and then
|
|
||||||
.Ar message .
|
|
||||||
.It Ic yesno_to_truefalse Ar var
|
|
||||||
Change the value of the specified variable from any of the
|
|
||||||
forms acceptable to the
|
|
||||||
.Ic checkyesno
|
|
||||||
function, to
|
|
||||||
.Dq true
|
|
||||||
or
|
|
||||||
.Dq false .
|
|
||||||
.El
|
|
||||||
.Sh FILES
|
|
||||||
.Bl -tag -width /etc/rc.subr -compact
|
|
||||||
.It Pa /etc/rc.subr
|
|
||||||
The
|
|
||||||
.Nm
|
|
||||||
file resides in
|
|
||||||
.Pa /etc .
|
|
||||||
.El
|
|
||||||
.Sh SEE ALSO
|
|
||||||
.Xr rc.conf 5 ,
|
|
||||||
.Xr rc 8
|
|
||||||
.Sh HISTORY
|
|
||||||
.Nm
|
|
||||||
appeared in
|
|
||||||
.Nx 1.3 .
|
|
||||||
The
|
|
||||||
.Xr rc.d 8
|
|
||||||
support functions appeared in
|
|
||||||
.Nx 1.5 .
|
|
||||||
Support for the
|
|
||||||
.Xr rc 8
|
|
||||||
post-processor appeared in
|
|
||||||
.Nx 6.0 .
|
|
||||||
|
|
@ -1,12 +0,0 @@
|
||||||
# $NetBSD: Makefile,v 1.2 2002/09/18 07:50:31 lukem Exp $
|
|
||||||
|
|
||||||
NOOBJ= # defined
|
|
||||||
|
|
||||||
.include <bsd.own.mk>
|
|
||||||
|
|
||||||
.if ${MKNLS} != "no"
|
|
||||||
FILES= nls.alias
|
|
||||||
FILESDIR=/usr/share/nls # XXX use NLSDIR?
|
|
||||||
|
|
||||||
.include <bsd.prog.mk>
|
|
||||||
.endif
|
|
||||||
|
|
@ -1,74 +0,0 @@
|
||||||
# $NetBSD: nls.alias,v 1.3 2003/04/14 05:21:51 salo Exp $
|
|
||||||
#
|
|
||||||
# This file defines aliase names of nls catalogs.
|
|
||||||
# Syntax is similar to X11's locale.alias.
|
|
||||||
# (The first word is an alias name and the second
|
|
||||||
# one is nls catalog name.)
|
|
||||||
|
|
||||||
ca_ES.ISO8859-1 ca
|
|
||||||
ca_ES.ISO8859-15 ca
|
|
||||||
cs_CZ.ISO8859-2 cs
|
|
||||||
#da_DK.ISO8859-1 da
|
|
||||||
#da_DK.ISO8859-15 da
|
|
||||||
de_AT.ISO8859-1 de
|
|
||||||
de_AT.ISO8859-15 de
|
|
||||||
de_CH.ISO8859-1 de
|
|
||||||
de_CH.ISO8859-15 de
|
|
||||||
de_DE.ISO8859-1 de
|
|
||||||
de_DE.ISO8859-15 de
|
|
||||||
#en_AU.ISO8859-1 en
|
|
||||||
#en_AU.ISO8859-15 en
|
|
||||||
#en_CA.ISO8859-1 en
|
|
||||||
#en_CA.ISO8859-15 en
|
|
||||||
#en_GB.ISO8859-1 en
|
|
||||||
#en_GB.ISO8859-15 en
|
|
||||||
#en_US.ISO8859-1 en
|
|
||||||
#en_US.ISO8859-15 en
|
|
||||||
#en_US.UTF-8 en
|
|
||||||
es_ES.ISO8859-1 es
|
|
||||||
es_ES.ISO8859-15 es
|
|
||||||
fi_FI.ISO8859-1 fi
|
|
||||||
fi_FI.ISO8859-15 fi
|
|
||||||
fr_BE.ISO8859-1 fr
|
|
||||||
fr_BE.ISO8859-15 fr
|
|
||||||
fr_CA.ISO8859-1 fr
|
|
||||||
fr_CA.ISO8859-15 fr
|
|
||||||
fr_CH.ISO8859-1 fr
|
|
||||||
fr_CH.ISO8859-15 fr
|
|
||||||
fr_FR.ISO8859-1 fr
|
|
||||||
fr_FR.ISO8859-15 fr
|
|
||||||
#hr_HR.ISO8859-2 hr
|
|
||||||
#hu_HU.ISO8859-2 hu
|
|
||||||
#is_IS.ISO8859-1 is
|
|
||||||
#is_IS.ISO8859-15 is
|
|
||||||
#it_CH.ISO8859-1 it
|
|
||||||
#it_CH.ISO8859-15 it
|
|
||||||
#it_IT.ISO8859-1 it
|
|
||||||
#it_IT.ISO8859-15 it
|
|
||||||
#ja_JP.ISO2022-JP ja
|
|
||||||
#ja_JP.ISO2022-JP2 ja
|
|
||||||
#ja_JP.SJIS ja
|
|
||||||
#ja_JP.ct ja
|
|
||||||
#ja_JP.eucJP ja
|
|
||||||
#ko_KR.eucKR ko
|
|
||||||
#lt_LT.ISO8859-4 lt
|
|
||||||
nl_BE.ISO8859-1 nl
|
|
||||||
nl_BE.ISO8859-15 nl
|
|
||||||
nl_NL.ISO8859-1 nl
|
|
||||||
nl_NL.ISO8859-15 nl
|
|
||||||
no_NO.ISO8859-1 no
|
|
||||||
no_NO.ISO8859-15 no
|
|
||||||
pl_PL.ISO8859-2 pl
|
|
||||||
#pt_PT.ISO8859-1 pt
|
|
||||||
#pt_PT.ISO8859-15 pt
|
|
||||||
#ru_RU.CP866 ru
|
|
||||||
#ru_RU.ISO8859-5 ru
|
|
||||||
#ru_RU.KOI8-R ru
|
|
||||||
#sl_SI.ISO8859-2 sl
|
|
||||||
sk_SK.ISO8859-2 sk
|
|
||||||
sv_SE.ISO8859-1 sv
|
|
||||||
sv_SE.ISO8859-15 sv
|
|
||||||
#uk_UA.KOI8-U uk
|
|
||||||
#zh_CN.eucCN zh
|
|
||||||
#zh_TW.Big5 zh
|
|
||||||
#zh_TW.eucTW zh
|
|
||||||
Loading…
Reference in New Issue
Block a user