Commit Graph

242 Commits

Author SHA1 Message Date
Colin Percival
cabad26453 Add support for "first boot" rc.d scripts. [1]
These scripts, containing
# KEYWORD: firstboot
will only be run if a sentinel file (default: /firstboot, configurable
via the rc.conf ${firstboot_sentinel} variable) exists; this sentinel
file will be deleted at the end of the boot process.

Scripts can request that the system reboot after the first boot by
creating the file ${firstboot_sentinel}-reboot.

This functionality is expected to be useful for embedded systems and
virtual machine images, where it may be desirable to
(a) download and install updates which became available between when
the image was created and when it was "turned on";
(b) download and install packages which may be newer than those
which were available when the image was created;
(c) install packages which run binaries during their install process,
bypassing the problem of cross-architecture installs;
(d) resize filesystems to match the disk onto which a VM image was
installed;
(e) perform initialization tasks relevant to cloud systems (e.g.,
Amazon's Elastic Compute Cloud);
and likely to perform many other one-time initialization functions.

Document this new functionality in rc.conf(5) and rc(8). [2]

Reviewed by:	freebsd-current, freebsd-rc [1]
Reviewed by:	Warren Block [2]
MFC after:	3 days
2013-10-19 21:37:06 +00:00
John-Mark Gurney
ff14d523bb Enable the automatic creation of a certificate (if one does not exists)
and enable the usage by sendmail if sendmail is enabled.  Include and
document knobs to disable this feature and also set the Common Name of
the certificate created.

As the certificate is signed w/ a discarded key, it only helps prevent
Eve, but not Malory from knowing the contents of the emails.

This means that new installs (and people that use the updated freebsd.mc
file) will automaticly have STARTTLS enabled allowing incoming email to
be encrypted in most cases.

Reviewed by:	gshapiro
MFC after:	3 days
Security:	Yes, please.
2013-10-19 18:51:06 +00:00
John-Mark Gurney
2a6b4327c2 add missing sections, de-Xr non-existent page, properly space
punctuation..

Approved by:	re (joel)
MFC after:	3 days
2013-10-07 16:49:53 +00:00
Sergey Kandaurov
05d98029e9 Sweep man pages replacing ad -> ada.
Approved by:	re (blackend)
MFC after:	1 week
X-MFC note:	stable/9 only
2013-10-01 18:41:53 +00:00
Dag-Erling Smørgrav
49cede74ee Add a setup script for unbound(8) called local-unbound-setup. It
generates a configuration suitable for running unbound as a caching
forwarding resolver, and configures resolvconf(8) to update unbound's
list of forwarders in addition to /etc/resolv.conf.  The initial list
is taken from the existing resolv.conf, which is rewritten to point to
localhost.  Alternatively, a list of forwarders can be provided on the
command line.

To assist this script, add an rc.subr command called "enabled" which
does nothing except return 0 if the service is enabled and 1 if it is
not, without going through the usual checks.  We should consider doing
the same for "status", which is currently pointless.

Add an rc script for unbound, called local_unbound.  If there is no
configuration file, the rc script runs local-unbound-setup to generate
one.

Note that these scripts place the unbound configuration files in
/var/unbound rather than /etc/unbound.  This is necessary so that
unbound can reload its configuration while chrooted.  We should
probably provide symlinks in /etc.

Approved by:	re (blanket)
2013-09-23 04:36:51 +00:00
Jamie Gritton
6a77419057 Mention the "nojailvnet" keyword.
MFC after:	3 days
2013-05-24 14:57:38 +00:00
Warren Block
344c81a166 Fixes to man8 groff mandoc style, usage mistakes, or typos.
PR:		168016
Submitted by:	Nobuyuki Koganemaru
Approved by:	gjb
MFC after:	3 days
2012-05-24 02:24:03 +00:00
Glen Barber
e907445846 Fix an mdoc(7) formatting nit. 2012-05-14 14:33:08 +00:00
Eitan Adler
50d675f7a9 Remove trailing whitespace per mdoc lint warning
Disussed with:	gavin
No objection from:	doc
Approved by:	joel
MFC after:	3 days
2012-03-29 05:02:12 +00:00
Doug Barton
c86072f5a7 Remove documentation for set_rcvar() now that it has been removed. 2012-01-14 21:51:44 +00:00
Eygene Ryabinkin
0113cca483 rc.d: document 'quiet' prefix and fix dhclient/devd interaction
Document the current semantics of the 'quiet' command prefix
in the rc.subr(8).

Fix dhclient rc.d script: it should not call err() for
non-DHCP-enabled interface when it is called from devd, because the
latter just blindly calls 'service dhclient quietstart' on each "link
up" event.

Since the 'quietstart' will silence the message "Cannot 'start' <foo>.
Set <foo>_enable to YES in /etc/rc.conf or use 'onestart' instead of
'start'." and running dhclient on the non-DHCP-enabled interface is
the same thing as running the service <foo> without <foo>_enable set,
such modification is in sync with the current semantics of the 'quiet'
prefix.

Approved by: glebius
Reviewed by: freebsd-rc list
MFC after:	2 weeks
2012-01-12 06:48:11 +00:00
Joel Dahl
8d6c73ab19 Add SEE ALSO. 2011-12-14 19:48:21 +00:00
Rick Macklem
6c8ea37c68 Change "options NFSCLIENT" to "options NFSCL" in diskless.8,
since that is now the default NFS client.
This is a content change.

Reported by:	shuvaev at physik.uni-wuerzburg.de
Approved by:	re (hrs)
2011-08-08 13:13:22 +00:00
Glen Barber
5d5140280b Fix various broken links in manual pages.
Submitted by:	Michiel Overtoom (motoom % xs4all nl)
PR:		159130 159131 159132 159133 159134
		159135 159136 159137 158138 159144
Approved by:	re (kib)
MFC after:	3 days
2011-07-23 22:55:32 +00:00
Ivan Voras
0d2653cb44 Sort Xr's by number then by name
Nitpicked by: niclas zeising at gmail.com :)
2011-07-12 14:18:54 +00:00
Ivan Voras
5a4c260750 Cross reference nanobsd(8) 2011-07-10 20:15:21 +00:00
Remko Lodder
a1f7c49554 Move the sticky manual from section 8 to section
7 like NetBSD has, since this is not a command
on itself.

PR:		124468
MFC after:	1 week
2011-02-24 13:03:47 +00:00
Doug Barton
eb581844e4 Remove references to MAKEDEV(8) 2010-11-15 05:25:51 +00:00
Ulrich Spörlein
0d9deed52c mdoc: drop redundant .Pp and .LP calls
They have no effect when coming in pairs, or before .Bl/.Bd
2010-10-08 12:40:16 +00:00
Wesley Shields
1ec7492c4e Document NANO_ARCH which is no longer hard coded as of r205980.
Approved by:	imp@
2010-05-20 18:39:33 +00:00
Ulrich Spörlein
aa12cea2cc mdoc: order prologue macros consistently by Dd/Dt/Os
Although groff_mdoc(7) gives another impression, this is the ordering
most widely used and also required by mdocml/mandoc.

Reviewed by:	ru
Approved by:	philip, ed (mentors)
2010-04-14 19:08:06 +00:00
Ed Maste
57984250f5 Clean up rc.subr man page after removing leftover NetBSD compat. Also
switch to 2-clause license per NetBSD rc.subr.8 r1.19.

Submitted by:	Alex Kozlov
2010-01-28 01:47:31 +00:00
Xin LI
3b5dbf01f7 rc.early(8) was removed as of 20090530 so remove manual page reference
to it.

MFC after:	1 week
2009-11-18 00:56:05 +00:00
Brian Somers
53c405786b Support shadow.byname and shadow.byuid maps, protecting them by
insisting on privileged port access.

Include /var/yp/Makefile.local if it exists and suggest using
it to override /var/yp/Makefile behaviour.

Approved by:	re (kib)
MFC after:	3 weeks
2009-06-25 16:15:39 +00:00
Luigi Rizzo
b94ee7c781 update the manpage to track existing options (including --iso),
and alphabetize them.

MFC after:	3 days
2009-06-25 09:28:04 +00:00
Sam Leffler
cdd7d4bcfe (finally) document -n 2009-03-16 15:54:21 +00:00
Robert Watson
49dd3b8df9 Don't suggest mounting procfs in diskless configurations.
MFC after:	3 days
2009-03-13 23:42:34 +00:00
Gabor Kovesdan
7bb456075e - Rename adding_user(8) to adding_user(7). There's no adding_user utility,
but the man page describes conceptual information about the process of
  adding a user, thus it should belong to section 7.
- Remove HISTORY and BUGS sections because of the aforementioned reason.

PR:		docs/130151
Submitted by:	Marian Cerny <jojo@matfyz.cz>
MFC after:	3 days
2009-01-30 15:14:58 +00:00
Lars Engels
fdec4b4190 Properly underline force_depend's parameter.
Reviewed by:	brueffer
2008-07-20 10:06:14 +00:00
Sergey Skvortsov
836d250db3 Fix punctiation.
Approved by:	ru
2008-03-31 14:11:37 +00:00
Yaroslav Tykhiy
8fe516386c o Add a note that checkyesno takes a variable by its name, not value.
o Improve mdoc(7) markup and style of the paragraph on stop_boot.
2007-10-26 09:38:54 +00:00
Xin LI
9a0e6be26a Stop mentioning /usr/X11R6.
Approved by:	re (hrs)
2007-07-24 06:41:07 +00:00
Ruslan Ermilov
54c41bc6a6 Fix markup. 2007-05-21 15:29:42 +00:00
Mike Makonnen
3d03791bb4 o Implement the stop_boot subroutine [1]. This subroutine can be used by
scripts in rc.d to stop rc(8) from booting into multi-user mode when
  a critical or severe error condition is encountered.

o Modify scripts in etc/rc.d that already implemented this functionality
  independently.

o Document it.

[1] - This subroutine was implemented in FreeBSD in rc.d/fsck. I moved it
      to rc.subr(8). Our version differs slightly in that it takes an
      optional argument to stop the boot even if "autoboot" is not set.

Obtained from: NetBSD
MFC after: 2 weeks
2007-05-18 12:04:41 +00:00
Adrian Chadd
cd4cf11a4d NanoBSD modifications:
* Break out the boot0 loader selection into a variable - NANO_BOOTLOADER -
  so people like me with VGA consoles can override the default (which is
  to use boot0sio)
* Put the boot0 configuration options in NANO_BOOT0CFG in case you want
  to override the defaults.
* Modify nanobsd.8 to reflect the changes and hint the console default is
  serial.

MFC after:	2 weeks
2007-04-20 07:21:09 +00:00
Yaroslav Tykhiy
6a8cdb5a0d MFp4:
Document my recent changes to rc.subr(8):
- there is $required_modules now;
- $required_* are checked before invoking a custom start method, too.

MFC after:	1 month
2006-12-27 13:22:41 +00:00
Craig Rodrigues
b6f0234db7 Remove reference to mount_devfs(8).
Reminded by:	ru
2006-11-22 11:45:06 +00:00
Daniel Gerzo
2792c5504c - capitalize the first letter of the first word in the sentence
Approved by: trhodes (mentor), keramida (mentor)
2006-11-05 20:08:58 +00:00
Ruslan Ermilov
0036760ce3 Make it clear that section 8 also documents system management
procedures, not necessarily commands.

PR:		docs/35011
Obtained from:	NetBSD (partly)
2006-10-21 20:35:49 +00:00
Ruslan Ermilov
81ae4b8da9 Markup fixes. 2006-09-18 15:24:20 +00:00
Daniel Gerzo
bf87e1ab26 Remove redundant vnconfig(8) from SEE ALSO section as it is linked to
mdconfig(8) on RELENG_[56] and HEAD, which is referenced too.

Approved by: keramida (mentor), trhodes (mentor)
MFC after: 1 week
2006-09-01 08:30:03 +00:00
Daniel Gerzo
129518b229 Add nanobsd(8) manual page.
Reviewed by: ru
Approved by: trhodes (mentor), keramida (mentor)
MFC after: 1 week
2006-08-29 09:12:48 +00:00
Florent Thoumie
3081bf98bf Backout this commit since it breaks startup and some scripts in
certain conditions. I haven't been able to find a better solution yet:

    - Set a two read-only variables (${prefix} and ${etcdir}). This is
    especially useful when using /etc/rc.d scripts with third-party
    software installed from ports.
    - Fix rc.d/sshd to work with openssh from ports using ${etcdir}
    instead of hardcoded /etc.
    - Reflect prefix/etcdir changes in rc.subr.8.

        src/etc/rc.d/sshd: rev 1.9 -> 1.10
        src/etc/rc.subr: rev 1.51 -> 1.52
        src/share/man/man8/rc.subr.8: rev 1.11 -> 1.12

Approved by:	cperciva (mentor)
2006-08-22 11:17:29 +00:00
Yaroslav Tykhiy
016c675db6 Improve mark-up: References to "start" as an rc.d method
should be tagged with ".Cm".  (Refs to "stop" are OK already.)

MFC after:	3 days
2006-07-24 10:07:27 +00:00
Yaroslav Tykhiy
a5fd4f0b19 Don't forget to touch Dd. 2006-06-21 11:46:29 +00:00
Yaroslav Tykhiy
1679c7f4f4 Quite a number of rc.d scripts try to load kernel modules. Many
of them do that conditionally depending on kldstat.  The code is
duplicated all over, but bugs can be uniqie.

To make the things more consistent, introduce a new rc.subr function,
load_kld, which takes care of loading a kernel module conditionally.

(Found this lying for a while in my p4 branch for various hacks.)
2006-06-21 09:42:55 +00:00
Florent Thoumie
8d2e10d0b9 Reflect latest changes in rc.subr wrt prefix/etcdir variables being set
automatically by load_rc_config.

With help from:	ru (mdoc-fu)
Reviewed by:	brueffer
Approved by:	cperciva
2006-06-07 10:20:57 +00:00
Florent Thoumie
46587ab898 - Sync rc.subr with NetBSD.
- Merge some documentation bits.

Reviewed by:	brooks, simon (doc)
Approved by:	cperciva (mentor)
Obtained from:	NetBSD
MFC after:	3 days
2006-04-04 10:52:15 +00:00
Yaroslav Tykhiy
c6136be413 Forgot to bump .Dd in the last commit. 2006-02-22 15:12:07 +00:00
Yaroslav Tykhiy
91387563e2 Document the relation between $command and $foo_program.
PR:		docs/68453
MFC after:	3 days
2006-02-22 10:57:19 +00:00