[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

clarify altroot section in afterboot and add a link



Hi,

After a question about altroot on #OpenBSD I checked the afterboot
manpage and found it rather confusing. At first I though ``xx''
was a variable. I had to read fstab(5) to find out that it
literally meant ``xx''

Also there is no manpage for altroot, so I want to suggest adding
a link to afterboot(8).

And I suggest adding a link in hier(7) to afterboot(8) since it
points to interesting documentation.

Here is a patch for these changes.


Index: man7/hier.7
===================================================================
RCS file: /cvs/src/share/man/man7/hier.7,v
retrieving revision 1.47
diff -u -p -r1.47 hier.7
--- man7/hier.7	15 Jul 2004 23:43:02 -0000	1.47
+++ man7/hier.7	1 Dec 2004 10:26:20 -0000
@@ -44,7 +44,8 @@ Root directory.
 .It /altroot/
 Alternate (backup) location for the root
 .Pq Sq /
-filesystem.
+filesystem. (see
+.Xr afterboot 8 ) .
 .It /bin/
 User utilities fundamental to both single and multi-user environments.
 These programs are statically compiled and therefore do not depend on any
Index: man8/Makefile
===================================================================
RCS file: /cvs/src/share/man/man8/Makefile,v
retrieving revision 1.51
diff -u -p -r1.51 Makefile
--- man8/Makefile	6 Aug 2004 23:05:19 -0000	1.51
+++ man8/Makefile	1 Dec 2004 10:26:20 -0000
@@ -11,6 +11,7 @@ MAN=	afterboot.8 boot_config.8 compat_ao
 	starttls.8 sticky.8 update.8 vpn.8 yp.8
 
 MLINKS+=afterboot.8 faq.8
+MLINKS+=afterboot.8 altroot.8
 MLINKS+=boot_config.8 UKC.8
 MLINKS+=daily.8 weekly.8 daily.8 monthly.8
 MLINKS+=rc.8 rc.local.8 rc.8 rc.securelevel.8
Index: man8/afterboot.8
===================================================================
RCS file: /cvs/src/share/man/man8/afterboot.8,v
retrieving revision 1.99
diff -u -p -r1.99 afterboot.8
--- man8/afterboot.8	9 Sep 2004 10:23:43 -0000	1.99
+++ man8/afterboot.8	1 Dec 2004 10:26:22 -0000
@@ -683,13 +683,14 @@ filesystem can optionally be used to pro
 root filesystem on a daily basis.
 To take advantage of this, you must have an entry in
 .Pa /etc/fstab
-with
+with the mount option
 .Dq xx
-for the mount option:
+(literally).
 .Pp
 .Dl /dev/wd0j /altroot ffs xx 0 0
 .Pp
-and you must add a line to root's crontab:
+and you must add a line to root's
+.Xr crontab 1 :
 .Pp
 .Dl ROOTBACKUP=1
 .Pp


# Han