please review mdoc

Colin Percival cperciva at
Thu Oct 17 19:36:04 UTC 2013

Hi docs people,

It's been a long time since I've edited a man page... can someone check
that the attached patch has correct mdoc?  This is for new functionality
which I hope to commit soon (thread on -rc and -current) and I figured I
really ought to document it. ;-)

Colin Percival
Security Officer Emeritus, FreeBSD | The power to serve
Founder, Tarsnap | | Online backups for the truly paranoid
-------------- next part --------------
Index: share/man/man5/rc.conf.5
--- share/man/man5/rc.conf.5	(revision 256432)
+++ share/man/man5/rc.conf.5	(working copy)
@@ -24,7 +24,7 @@
 .\" $FreeBSD$
-.Dd October 12, 2013
+.Dd October 17, 2013
 .Dt RC.CONF 5
@@ -3675,6 +3675,21 @@
 is set to
 .Dq Li YES ,
 this specifies a list of additional iBCS2 loaders to enable.
+.It Va firstboot_sentinel
+.Pq Vt str
+This variable specifies the full path to a
+.Dq first boot
+sentinel file.
+If a file exists with this path,
+.Pa rc.d
+with the
+.Dq firstboot
+keyword will be run on startup and the sentinel file will be deleted
+after the boot process completes.
+Note that this file must be placed on a non-ephemeral read-write
+filesystem in order for this to function properly.
+The default is
+.Pa /firstboot .
 .It Va linux_enable
 .Pq Vt bool
 Set to
Index: share/man/man8/rc.8
--- share/man/man8/rc.8	(revision 256432)
+++ share/man/man8/rc.8	(working copy)
@@ -35,7 +35,7 @@
 .\"     @(#)rc.8	8.2 (Berkeley) 12/11/93
 .\" $FreeBSD$
-.Dd September 23, 2013
+.Dd October 17, 2013
 .Dt RC 8
@@ -129,6 +129,13 @@
 (only allow vnet-enabled jails) to the list of KEYWORDS to skip in
 .Xr rcorder 8 .
+If the file
+.Va ${firstboot_sentinel}
+does not exist, add
+.Dq Li firstboot
+to the list of KEYWORDS to skip in
+.Xr rcorder 8 .
 .Xr rcorder 8
 to order the files in
@@ -156,6 +163,11 @@
 .Va $early_late_divider
 has been run.
+Check again to see if the file
+.Va ${firstboot_sentinel}
+exists (in case it is located on a newly mounted filesystem)
+and adjust the list of KEYWORDs to skip appropriately.
 .Xr rcorder 8 ,
 this time including the scripts in the
@@ -164,6 +176,13 @@
 Ignore everything up to the
 .Va $early_late_divider ,
 then start executing the scripts as described above.
+If the file
+.Va ${firstboot_sentinel}
+exists and the file
+.Va ${firstboot_sentinel}-reboot
+has been created by a script, then reboot.
+Delete one or both files.
 .Ss Operation of Nm rc.shutdown
 .Bl -enum

More information about the freebsd-doc mailing list