summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorRoger Leigh <rleigh@debian.org>2011-11-27 18:10:34 +0000
committerRoger Leigh <rleigh@debian.org>2011-11-27 18:10:34 +0000
commite5a9f47743b509afa88353fd0895cc6cfc3bbb0b (patch)
tree21bf71c81395188de7b6dd4e8e52319a0d40eae0
parent3f0abc31cb65f32c23ca447fe4e7104210fcd8f6 (diff)
downloadschroot-e5a9f47743b509afa88353fd0895cc6cfc3bbb0b.tar.gz
man: Reformat examples and corrections
-rw-r--r--man/Makefile.am9
-rw-r--r--man/copyright.man8
-rw-r--r--man/csbuild.1.man83
-rw-r--r--man/dchroot-dsa.1.man62
-rw-r--r--man/dchroot.1.man83
-rw-r--r--man/schroot-faq.7.man81
-rw-r--r--man/schroot-script-config.5.man2
-rw-r--r--man/schroot-setup.5.man2
-rw-r--r--man/schroot.1.man377
-rw-r--r--man/schroot.conf.5.man163
10 files changed, 357 insertions, 513 deletions
diff --git a/man/Makefile.am b/man/Makefile.am
index 93bdea55..2dbe1744 100644
--- a/man/Makefile.am
+++ b/man/Makefile.am
@@ -76,6 +76,15 @@ CLEANFILES = \
%.7: %.7.man $(EXPAND)
$(SOELIM) $< >$@
+%.1.ps: %.1
+ groffer -Tps -man <$< >$@
+
+%.5.ps: %.5
+ groffer -Tps -man <$< >$@
+
+%.7.ps: %.7
+ groffer -Tps -man <$< >$@
+
CONFIG =\
.ds RELEASE_DATE $(RELEASE_DATE_S)\n\
.ds VERSION $(VERSION)\n\
diff --git a/man/copyright.man b/man/copyright.man
index e818066f..43effad0 100644
--- a/man/copyright.man
+++ b/man/copyright.man
@@ -1,7 +1,7 @@
.SH COPYRIGHT
Copyright \(co 2005\-2011 Roger Leigh \f[CR]<rleigh@debian.org>\fP
.PP
-\fB\*[PROGRAM]\fP is free software: you can redistribute it and/or modify it under
-the terms of the GNU General Public License as published by the Free Software
-Foundation, either version 3 of the License, or (at your option) any later
-version.
+\fB\*[PROGRAM]\fP is free software: you can redistribute it and/or
+modify it under the terms of the GNU General Public License as
+published by the Free Software Foundation, either version 3 of the
+License, or (at your option) any later version.
diff --git a/man/csbuild.1.man b/man/csbuild.1.man
index 7a86612b..0e169de7 100644
--- a/man/csbuild.1.man
+++ b/man/csbuild.1.man
@@ -16,7 +16,7 @@
.\"
.so config.man
.ds PROGRAM csbuild
-.TH CSBUILD 1 "\*[RELEASE_DATE_S]" "Version \*[VERSION]" "Debian sbuild"
+.TH CSBUILD 1 "\*[RELEASE_DATE]" "Version \*[VERSION]" "Debian sbuild"
.SH NAME
csbuild \- build debian packages from source
.SH SYNOPSIS
@@ -132,14 +132,12 @@ The first chroot is also the default chroot.
An example file:
.PP
.RS
-\f[CR]# Example comment\fP
-.br
-\f[CR]\fP
-.br
-\f[CR]sarge /srv/chroot/sarge\fP
-.br
-\f[CR]sid /srv/chroot/sid linux32\fP
-.br
+.EX
+# Example comment
+
+sarge /srv/chroot/sarge
+sid /srv/chroot/sid linux32
+.EE
.RE
.PP
This file defines a chroot called \[oq]sarge\[cq], located at
@@ -196,8 +194,9 @@ Dump the csbuild configuration in schroot keyfile format to
\fI\*[SCHROOT_CONF]\fP.
.PP
.RS
-\f[CR]# \f[CB]csbuild --config >> \*[SCHROOT_CONF]
-.br
+.EX
+# \f[CB]csbuild --config >> \*[SCHROOT_CONF]\fP\[CR]
+.EE
.RE
.PP
.IP 2
@@ -209,46 +208,28 @@ configuration. See
Remove \fI\*[CSBUILD_CONF]\fP, so that csbuild will subsequently use
\fI\*[SCHROOT_CONF]\fP for its configuration.
.SH EXAMPLES
-\f[CR]$ \f[CB]csbuild \-l\fP\fP
-.br
-\f[CR]Available chroots: sarge [default], sid\fP
-.br
-\f[CR]\fP
-.br
-\f[CR]$ \f[CB]csbuild \-p sid\fP\fP
-.br
-\f[CR]/srv/chroot/sid\fP
-.br
-\f[CR]\fP
-.br
-\f[CR]$ \f[CB]csbuild \-q \-c sid \-\- uname \-smr\fP\fP
-.br
-\f[CR]Linux 2.6.16.17 ppc\fP
-.br
-\f[CR]$ \f[CB]csbuild \-q \-c sid \-\- "uname \-smr"\fP\fP
-.br
-\f[CR]Linux 2.6.16.17 ppc\fP
-.br
-\f[CR]\fP
-.br
-\f[CR]$ \f[CB]csbuild -q -c sid "ls -1 / | tac | head -n 4"\fP\fP
-.br
-\f[CR]var\fP
-.br
-\f[CR]usr\fP
-.br
-\f[CR]tmp\fP
-.br
-\f[CR]sys\fP
-.br
-\f[CR]\fP
-.br
-\f[CR]$ \f[CB]csbuild \-c sid\fP\fP
-.br
-\f[CR]I: [sid chroot] Running login shell: \[lq]/bin/bash\[rq]\fP
-.br
-\f[CR]$ \fP
-.br
+.EX
+$ \f[CB]csbuild \-l\fP\[CR]
+Available chroots: sarge [default], sid
+
+$ \f[CB]csbuild \-p sid\fP\[CR]
+/srv/chroot/sid
+
+$ \f[CB]csbuild \-q \-c sid \-\- uname \-smr\fP\[CR]
+Linux 2.6.16.17 ppc
+$ \f[CB]csbuild \-q \-c sid \-\- "uname \-smr"\fP\[CR]
+Linux 2.6.16.17 ppc
+
+$ \f[CB]csbuild -q -c sid "ls -1 / | tac | head -n 4"\fP\[CR]
+var
+usr
+tmp
+sys
+
+$ \f[CB]csbuild \-c sid\fP\[CR]
+I: [sid chroot] Running login shell: \[lq]/bin/bash\[rq]
+$
+.EE
.LP
Use \fI\-\-\fP to allow options beginning with \[oq]\-\[cq] or \[oq]\-\-\[cq]
in the command to run in the chroot. This prevents them being interpreted as
diff --git a/man/dchroot-dsa.1.man b/man/dchroot-dsa.1.man
index cfc50cdd..6475260f 100644
--- a/man/dchroot-dsa.1.man
+++ b/man/dchroot-dsa.1.man
@@ -17,7 +17,7 @@
.\"
.so config.man
.ds PROGRAM dchroot\-dsa
-.TH DCHROOT-DSA 1 "\*[RELEASE_DATE_S]" "Version \*[VERSION]" "Debian sbuild"
+.TH DCHROOT-DSA 1 "\*[RELEASE_DATE]" "Version \*[VERSION]" "Debian sbuild"
.SH NAME
dchroot\-dsa \- enter a chroot environment
.SH SYNOPSIS
@@ -121,14 +121,12 @@ or comma (\[oq],\[cq]).
An example file:
.PP
.RS
-\f[CR]# Example comment\fP
-.br
-\f[CR]\fP
-.br
-\f[CR]sarge /srv/chroot/sarge\fP
-.br
-\f[CR]sid /srv/chroot/sid rleigh,fred\fP
-.br
+.EX
+# Example comment
+\fP
+sarge /srv/chroot/sarge
+sid /srv/chroot/sid rleigh,fred
+.EE
.RE
.PP
This file defines a chroot called \[oq]sarge\[cq], located at
@@ -170,8 +168,9 @@ Dump the dchroot\-dsa configuration in schroot keyfile format to
\fI\*[SCHROOT_CONF]\fP.
.PP
.RS
-\f[CR]# \f[CB]dchroot\-dsa --config >> \*[SCHROOT_CONF]
-.br
+.EX
+# \f[CB]dchroot\-dsa --config >> \*[SCHROOT_CONF]\fP\[CR]
+.EE
.RE
.PP
.IP 2
@@ -227,32 +226,21 @@ No fallbacks should exist under any circumstances.
Note that \fI\-\-debug=notice\fP will show the internal fallback list computed
for the session.
.SH EXAMPLES
-\f[CR]$ \f[CB]dchroot\-dsa -l\fP\fP
-.br
-\f[CR]Available chroots: sarge, sid\fP
-.br
-\f[CR]\fP
-.br
-\f[CR]$ \f[CB]dchroot\-dsa \-\-listpaths\fP\fP
-.br
-\f[CR]/srv/chroot/sarge\fP
-.br
-\f[CR]/srv/chroot/sid\fP
-.br
-\f[CR]\fP
-.br
-\f[CR]$ \f[CB]dchroot\-dsa \-q sid \-\- /bin/uname\fP\fP
-.br
-\f[CR]Linux\fP
-.br
-\f[CR]\fP
-.br
-\f[CR]$ \f[CB]dchroot\-dsa sid\fP\fP
-.br
-\f[CR]I: [sid chroot] Running login shell: \[lq]/bin/bash\[rq]\fP
-.br
-\f[CR]$ \fP
-.br
+.EX
+$ \f[CB]dchroot\-dsa -l\fP\[CR]
+Available chroots: sarge, sid
+
+$ \f[CB]dchroot\-dsa \-\-listpaths\fP\[CR]
+/srv/chroot/sarge
+/srv/chroot/sid
+
+$ \f[CB]dchroot\-dsa \-q sid \-\- /bin/uname\fP\[CR]
+Linux
+
+$ \f[CB]dchroot\-dsa sid\fP\[CR]
+I: [sid chroot] Running login shell: \[lq]/bin/bash\[rq]
+$
+.EE
.LP
Note that the top line was echoed to standard error, and the remaining lines to
standard output. This is intentional, so that program output from commands run
diff --git a/man/dchroot.1.man b/man/dchroot.1.man
index ff5e1ff3..2e0123fe 100644
--- a/man/dchroot.1.man
+++ b/man/dchroot.1.man
@@ -17,7 +17,7 @@
.\"
.so config.man
.ds PROGRAM dchroot
-.TH DCHROOT 1 "\*[RELEASE_DATE_S]" "Version \*[VERSION]" "Debian sbuild"
+.TH DCHROOT 1 "\*[RELEASE_DATE]" "Version \*[VERSION]" "Debian sbuild"
.SH NAME
dchroot \- enter a chroot environment
.SH SYNOPSIS
@@ -133,14 +133,12 @@ The first chroot is also the default chroot.
An example file:
.PP
.RS
-\f[CR]# Example comment\fP
-.br
-\f[CR]\fP
-.br
-\f[CR]sarge /srv/chroot/sarge\fP
-.br
-\f[CR]sid /srv/chroot/sid linux32\fP
-.br
+.EX
+# Example comment
+
+sarge /srv/chroot/sarge
+sid /srv/chroot/sid linux32
+.EE
.RE
.PP
This file defines a chroot called \[oq]sarge\[cq], located at
@@ -197,8 +195,9 @@ Dump the dchroot configuration in schroot keyfile format to
\fI\*[SCHROOT_CONF]\fP.
.PP
.RS
-\f[CR]# \f[CB]dchroot --config >> \*[SCHROOT_CONF]
-.br
+.EX
+# \f[CB]dchroot --config >> \*[SCHROOT_CONF]\fP\[CR]
+.EE
.RE
.PP
.IP 2
@@ -272,46 +271,28 @@ No fallbacks should exist under any circumstances.
Note that \fI\-\-debug=notice\fP will show the internal fallback list computed
for the session.
.SH EXAMPLES
-\f[CR]$ \f[CB]dchroot \-l\fP\fP
-.br
-\f[CR]Available chroots: sarge [default], sid\fP
-.br
-\f[CR]\fP
-.br
-\f[CR]$ \f[CB]dchroot \-p sid\fP\fP
-.br
-\f[CR]/srv/chroot/sid\fP
-.br
-\f[CR]\fP
-.br
-\f[CR]$ \f[CB]dchroot \-q \-c sid \-\- uname \-smr\fP\fP
-.br
-\f[CR]Linux 2.6.16.17 ppc\fP
-.br
-\f[CR]$ \f[CB]dchroot \-q \-c sid \-\- "uname \-smr"\fP\fP
-.br
-\f[CR]Linux 2.6.16.17 ppc\fP
-.br
-\f[CR]\fP
-.br
-\f[CR]$ \f[CB]dchroot -q -c sid "ls -1 / | tac | head -n 4"\fP\fP
-.br
-\f[CR]var\fP
-.br
-\f[CR]usr\fP
-.br
-\f[CR]tmp\fP
-.br
-\f[CR]sys\fP
-.br
-\f[CR]\fP
-.br
-\f[CR]$ \f[CB]dchroot \-c sid\fP\fP
-.br
-\f[CR]I: [sid chroot] Running login shell: \[lq]/bin/bash\[rq]\fP
-.br
-\f[CR]$ \fP
-.br
+.EX
+$ \f[CB]dchroot \-l\fP\[CR]
+Available chroots: sarge [default], sid
+
+$ \f[CB]dchroot \-p sid\fP\[CR]
+/srv/chroot/sid
+
+$ \f[CB]dchroot \-q \-c sid \-\- uname \-smr\fP\[CR]
+Linux 2.6.16.17 ppc
+$ \f[CB]dchroot \-q \-c sid \-\- "uname \-smr"\fP\[CR]
+Linux 2.6.16.17 ppc
+
+$ \f[CB]dchroot -q -c sid "ls -1 / | tac | head -n 4"\fP\[CR]
+var
+usr
+tmp
+sys
+
+$ \f[CB]dchroot \-c sid\fP\[CR]
+I: [sid chroot] Running login shell: \[lq]/bin/bash\[rq]
+$
+.EE
.LP
Use \fI\-\-\fP to allow options beginning with \[oq]\-\[cq] or \[oq]\-\-\[cq]
in the command to run in the chroot. This prevents them being interpreted as
diff --git a/man/schroot-faq.7.man b/man/schroot-faq.7.man
index 0bd329c8..d0d8f2a1 100644
--- a/man/schroot-faq.7.man
+++ b/man/schroot-faq.7.man
@@ -15,7 +15,7 @@
.\" <http://www.gnu.org/licenses/>.
.\"
.so config.man
-.TH SCHROOT-FAQ 7 "\*[RELEASE_DATE_S]" "Version \*[VERSION]" "Debian sbuild"
+.TH SCHROOT-FAQ 7 "\*[RELEASE_DATE]" "Version \*[VERSION]" "Debian sbuild"
.SH NAME
schroot \- frequently asked questions
.SH DESCRIPTION
@@ -118,12 +118,15 @@ For example, to remove a session named
\fImy-session\fP by hand:
.IP \[bu]
Remove the session configuration file
-.br
-\f[CR]%\ \f[CB]rm\ \*[SCHROOT_SESSION_DIR]/my\-session\fP\fP\[CR]
+.EX
+%\ \f[CB]rm\ \*[SCHROOT_SESSION_DIR]/my\-session\fP\[CR]
+.EE
.IP \[bu]
Check for mounted filesystems
-.br
-\f[CR]%\ \f[CB]\*[SCHROOT_LIBEXEC_DIR]/schroot\-listmounts\ \-m\ \*[SCHROOT_MOUNT_DIR]/my\-session\fP\fP\[CR]
+.EX
+%\ \f[CB]\*[SCHROOT_LIBEXEC_DIR]/schroot\-listmounts\ \-m\ \\
+ \*[SCHROOT_MOUNT_DIR]/my\-session\fP\[CR]
+.EE
.IP \[bu]
Unmount any mounted filesystems
.IP \[bu]
@@ -138,8 +141,9 @@ still be bind mounted. Doing so could cause irretrievable data loss!
.SH ADVANCED USAGE
.SS How do I use sessions?
In normal use, running a command might look like this:
-.br
-\f[CR]%\ \f[CB]schroot\ \-c squeeze \-\- command\fP\fP\[CR]
+.EX
+%\ \f[CB]schroot\ \-c squeeze \-\- command\fP\[CR]
+.EE
.PP
which would run the command \fIcommand\fP in the \fIsqueeze\fP chroot. While
it's not apparent that a session is being used here, schroot is actually doing
@@ -169,54 +173,58 @@ is persistent and won't be automatically removed. With a session, you can run
as many commands as you like, but you need to create and delete the session by
hand since schroot can't know by itself when you're done with it unlike in the
single command case above. This is quite easy:
-.br
-\f[CR]% \f[CB]schroot \-\-begin\-session \-c squeeze\fP\fP\[CR]
-.br
-\f[CR]squeeze\-57a69547\-e014\-4f5d\-a98b\-f4f35a005307\fP
+.EX
+% \f[CB]schroot \-\-begin\-session \-c squeeze\fP\[CR]
+squeeze\-57a69547\-e014\-4f5d\-a98b\-f4f35a005307
+.EE
.PP
This created a new session based upon the \fIsqueeze\fP chroot. The unique
name for the session, the session ID, was printed to standard output, so we
could also save it as a shell variable at the same time like so:
-.br
-\f[CR]% \f[CB]SESSION=$(schroot \-\-begin\-session \-c squeeze)\fP\fP\[CR]
-.br
-\f[CR]% \f[CB]echo $SESSION\fP\fP\[CR]
-.br
-\f[CR]squeeze\-57a69547\-e014\-4f5d\-a98b\-f4f35a005307\fP
+.EX
+% \f[CB]SESSION=$(schroot \-\-begin\-session \-c squeeze)\fP\[CR]
+% \f[CB]echo $SESSION\fP\[CR]
+squeeze\-57a69547\-e014\-4f5d\-a98b\-f4f35a005307
+.EE
.PP
Now we have created the session and got the session ID, we can run commands in
it using the session ID:
-.br
-\f[CR]% \f[CB]schroot \-\-run\-session \-c squeeze\-57a69547\-e014\-4f5d\-a98b\-f4f35a005307 \-\- command1\fP\fP\[CR]
+.EX
+% \f[CB]schroot \-\-run\-session \-c squeeze\-57a69547\-e014\-4f5d\-a98b\-f4f35a005307 \\
+ \-\- command1\fP\[CR]
+.EE
.PP
or
-.br
-\f[CR]% \f[CB]schroot \-\-run\-session \-c "$SESSION" \-\- command1\fP\fP\[CR]
+.EX
+% \f[CB]schroot \-\-run\-session \-c "$SESSION" \-\- command1\fP\[CR]
+.EE
.PP
and then as many more commands as we like
-.br
-\f[CR]% \f[CB]schroot \-\-run\-session \-c "$SESSION" \-\- command2\fP\fP\[CR]
-.br
-\f[CR]% \f[CB]schroot \-\-run\-session \-c "$SESSION" \-\- command3\fP\fP\[CR]
-.br
-\f[CR]% \f[CB]schroot \-\-run\-session \-c "$SESSION" \-\- command4\fP\fP\[CR]
+.EX
+% \f[CB]schroot \-\-run\-session \-c "$SESSION" \-\- command2\fP\[CR]
+% \f[CB]schroot \-\-run\-session \-c "$SESSION" \-\- command3\fP\[CR]
+% \f[CB]schroot \-\-run\-session \-c "$SESSION" \-\- command4\fP\[CR]
+.EE
.PP
etc.
.PP
When we are done with the session, we can remove it with \fI\-\-end\-session\fP:
-.br
-\f[CR]% \f[CB]schroot \-\-end\-session \-c squeeze\-57a69547\-e014\-4f5d\-a98b\-f4f35a005307\fP\fP\[CR]
+.EX
+% \f[CB]schroot \-\-end\-session \-c squeeze\-57a69547\-e014\-4f5d\-a98b\-f4f35a005307\fP\[CR]
+.EE
.PP
or
-.br
-\f[CR]% \f[CB]schroot \-\-end\-session \-c $SESSION\fP\fP\[CR]
+.EX
+% \f[CB]schroot \-\-end\-session \-c "$SESSION"\fP\[CR]
+.EE
.PP
Since the automatically generated session names can be long and unwieldy, the
\fI\-\-session\-name\fP option allows you to provide you own name:
.PP
-\f[CR]% \f[CB]schroot \-\-begin\-session \-c squeeze \-\-session\-name my\-name\fP\fP\[CR]
-.br
-\f[CR]my\-name\fP
+.EX
+% \f[CB]schroot \-\-begin\-session \-c squeeze \-\-session\-name my\-name\fP\[CR]
+my\-name
+.EE
.SH CONTRIBUTING
.SS Getting help and getting involved
The mailing list \f[CR]<buildd-tools-devel@lists.alioth.debian.org>\fP is used
@@ -233,8 +241,9 @@ tool, or alternatively by mailing \f[CR]<submit@bugs.debian.org>\fP (see
.SS Getting the latest sources
schroot is maintained in the git version control system. You can get the
latest sources from \f[CR]git://git.debian.org/git/buildd-tools/schroot\fP.
-.br
-\f[CR]% \f[CB]git clone git://git.debian.org/git/buildd-tools/schroot\fP\fP\[CR]
+.EX
+% \f[CB]git clone git://git.debian.org/git/buildd-tools/schroot\fP\[CR]
+.EE
.LP
The master branch containes the current development release. Stable releases
are found on branches, for example the 1.4 series of releases are on
diff --git a/man/schroot-script-config.5.man b/man/schroot-script-config.5.man
index 39c241fd..1ec89e16 100644
--- a/man/schroot-script-config.5.man
+++ b/man/schroot-script-config.5.man
@@ -15,7 +15,7 @@
.\" <http://www.gnu.org/licenses/>.
.\"
.so config.man
-.TH SCHROOT-SCRIPT-CONFIG 5 "\*[RELEASE_DATE_S]" "Version \*[VERSION]" "Debian sbuild"
+.TH SCHROOT-SCRIPT-CONFIG 5 "\*[RELEASE_DATE]" "Version \*[VERSION]" "Debian sbuild"
.SH NAME
schroot-script-config \- schroot chroot setup script configuration
.SH DESCRIPTION
diff --git a/man/schroot-setup.5.man b/man/schroot-setup.5.man
index 6aee20eb..f8189799 100644
--- a/man/schroot-setup.5.man
+++ b/man/schroot-setup.5.man
@@ -15,7 +15,7 @@
.\" <http://www.gnu.org/licenses/>.
.\"
.so config.man
-.TH SCHROOT\-SETUP 5 "\*[RELEASE_DATE_S]" "Version \*[VERSION]" "Debian sbuild"
+.TH SCHROOT\-SETUP 5 "\*[RELEASE_DATE]" "Version \*[VERSION]" "Debian sbuild"
.SH NAME
schroot\-setup \- schroot chroot setup scripts
.SH DESCRIPTION
diff --git a/man/schroot.1.man b/man/schroot.1.man
index b3307f78..eb70d556 100644
--- a/man/schroot.1.man
+++ b/man/schroot.1.man
@@ -17,7 +17,7 @@
.\" <http://www.gnu.org/licenses/>.
.\"
.so config.man
-.TH SCHROOT 1 "\*[RELEASE_DATE_S]" "Version \*[VERSION]" "Debian sbuild"
+.TH SCHROOT 1 "\*[RELEASE_DATE]" "Version \*[VERSION]" "Debian sbuild"
.SH NAME
schroot \- securely enter a chroot environment
.SH SYNOPSIS
@@ -367,90 +367,58 @@ Note that \fI\-\-debug=notice\fP will show the internal fallback list computed
for the session.
.SH EXAMPLES
.SS List available chroots
-\f[CR]%\ \f[CB]schroot \-l\fP\fP\[CR]
-.br
-\f[CR]chroot:default\fP
-.br
-\f[CR]chroot:etch\fP
-.br
-\f[CR]chroot:sid\fP
-.br
-\f[CR]chroot:testing\fP
-.br
-\f[CR]chroot:unstable\fP
+.EX
+% \f[CB]schroot \-l\fP\[CR]
+chroot:default
+chroot:etch
+chroot:sid
+chroot:testing
+chroot:unstable
+.EE
.SS Get information about a chroot
-\f[CR]%\ \f[CB]schroot\ \-i\ \-c\ sid\fP\fP\[CR]
-.br
-\f[CR]\ \ \[em]\[em]\[em]\ Chroot\ \[em]\[em]\[em]\fP
-.br
-\f[CR]\ \ Name\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ sid\fP
-.br
-\f[CR]\ \ Description\ \ \ \ \ \ \ \ \ \ \ \ Debian sid (unstable)\fP
-.br
-\f[CR]\ \ Type\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ plain\fP
-.br
-\f[CR]\ \ Priority\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ 3\fP
-.br
-\f[CR]\ \ Users\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ rleigh\fP
-.br
-\f[CR]\ \ Groups\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ sbuild\fP
-.br
-\f[CR]\ \ Root\ Users\fP
-.br
-\f[CR]\ \ Root\ Groups\ \ \ \ \ \ \ \ \ \ \ \ sbuild\fP
-.br
-\f[CR]\ \ Aliases\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ unstable\ unstable\-sbuild\ unstable\-p\fP
-.br
-\f[CR]owerpc\-sbuild\fP
-.br
-\f[CR]\ \ Environment\ Filter\ \ \ \ \ ^(BASH_ENV|CDPATH|ENV|HOSTALIASES|I\fP
-.br
-\f[CR]FS|KRB5_CONFIG|KRBCONFDIR|KRBTKFILE|KRB_CONF|LD_.*|LOCALDOMA\fP
-.br
-\f[CR]IN|NLSPATH|PATH_LOCALE|RES_OPTIONS|TERMINFO|TERMINFO_DIRS|TE\fP
-.br
-\f[CR]RMPATH)$\fP
-.br
-\f[CR]\ \ Run\ Setup\ Scripts\ \ \ \ \ \ true\fP
-.br
-\f[CR]\ \ Script\ Configuration\ \ \ script\-defaults\fP
-.br
-\f[CR]\ \ Session\ Managed\ \ \ \ \ \ \ \ true\fP
-.br
-\f[CR]\ \ Personality\ \ \ \ \ \ \ \ \ \ \ \ linux32\fP
-.br
-\f[CR]\ \ Location\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ /srv/chroot/sid\fP
+.EX
+% \f[CB]schroot \-i \-c sid\fP\[CR]
+ \[em]\[em]\[em] Chroot \[em]\[em]\[em]
+ Name sid
+ Description Debian sid (unstable)
+ Type plain
+ Priority 3
+ Users rleigh
+ Groups sbuild
+ Root Users
+ Root Groups sbuild
+ Aliases unstable unstable\-sbuild unstable\-p
+owerpc\-sbuild
+ Environment Filter ^(BASH_ENV|CDPATH|ENV|HOSTALIASES|I\\
+FS|KRB5_CONFIG|KRBCONFDIR|KRBTKFILE|KRB_CONF|LD_.*|LOCALDOMA\\
+IN|NLSPATH|PATH_LOCALE|RES_OPTIONS|TERMINFO|TERMINFO_DIRS|TE\\
+RMPATH)$
+ Run Setup Scripts true
+ Script Configuration script\-defaults
+ Session Managed true
+ Personality linux32
+ Location /srv/chroot/sid
+.EE
.LP
Use \fI\-\-all\fP or \fI\-c\fP multiple times to use all or multiple chroots,
respectively.
.SS Running commands in a chroot
-\f[CR]%\ \f[CB]schroot \-c sid /bin/ls\fP\fP\[CR]
-.br
-\f[CR][sid chroot] Running command: \[lq]/bin/ls\[rq]\fP
-.br
-\f[CR]CVS sbuild\-chroot.c sbuild\-session.h schroot.conf.5\fP
-.br
-\f[CR]Makefile sbuild\-chroot.h schroot.1 schroot.conf.5.in\fP
-.br
-\f[CR]Makefile.am sbuild\-config.c schroot.1.in\fP
-.br
-\f[CR]Makefile.in sbuild\-config.h schroot.c\fP
-.br
-\f[CR]pam sbuild\-session.c schroot.conf\fP
-.PP
-\f[CR]%\ \f[CB]schroot \-c sid \-\- ls \-1 | head \-n 5\fP\fP\[CR]
-.br
-\f[CR][sid chroot] Running command: \[lq]ls \-1\[rq]\fP
-.br
-\f[CR]ABOUT\-NLS\fP
-.br
-\f[CR]AUTHORS\fP
-.br
-\f[CR]COPYING\fP
-.br
-\f[CR]ChangeLog\fP
-.br
-\f[CR]INSTALL\fP
+.EX
+% \f[CB]schroot \-c sid /bin/ls\fP\[CR]
+[sid chroot] Running command: \[lq]/bin/ls\[rq]
+CVS sbuild\-chroot.c sbuild\-session.h schroot.conf.5
+Makefile sbuild\-chroot.h schroot.1 schroot.conf.5.in
+Makefile.am sbuild\-config.c schroot.1.in
+Makefile.in sbuild\-config.h schroot.c
+pam sbuild\-session.c schroot.conf
+% \f[CB]schroot \-c sid \-\- ls \-1 | head \-n 5\fP\[CR]
+[sid chroot] Running command: \[lq]ls \-1\[rq]
+ABOUT\-NLS
+AUTHORS
+COPYING
+ChangeLog
+INSTALL
+.EE
.LP
Use \fI\-\-\fP to allow options beginning with \[oq]\-\[cq] or \[oq]\-\-\[cq]
in the command to run in the chroot. This prevents them being interpreted as
@@ -460,13 +428,12 @@ that program output from commands run in the chroot may be piped and redirected
as required; the data will be the same as if the command was run directly on
the host system.
.SS Switching users
-\f[CR]%\ \f[CB]schroot \-c sid \-u root\fP\fP\[CR]
-.br
-\f[CR]Password:\fP
-.br
-\f[CR][sid chroot] (rleigh\[->]root) Running login shell: \[lq]/bin/bash\[rq]\fP
-.br
-\f[CR]# \fP
+.EX
+% \f[CB]schroot \-c sid \-u root\fP\[CR]
+Password:
+[sid chroot] (rleigh\[->]root) Running login shell: \[lq]/bin/bash\[rq]
+#
+.EE
.LP
If the user \[oq]rleigh\[cq] was in \f[CI]root\-users\fP in
\fI\*[SCHROOT_CONF]\fP, or one of the groups he belonged to was in
@@ -482,175 +449,123 @@ strictly necessary.
.PP
Let's start by looking at a session-capable chroot:
.PP
-\f[CR]%\ \f[CB]schroot\ \-i\ \-c\ sid\-snap\fP\fP\[CR]
-.br
-\f[CR]\ \ \[em]\[em]\[em]\ Chroot\ \[em]\[em]\[em]\fP
-.br
-\f[CR]\ \ Name\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ sid\-snap\fP
-.br
-\f[CR]\ \ Description\ \ \ \ \ \ \ \ \ \ \ \ Debian sid snapshot\fP
-.br
-\f[CR]\ \ Type\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ lvm\-snapshot\fP
-.br
-\f[CR]\ \ Priority\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ 3\fP
-.br
-\f[CR]\ \ Users\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ maks rleigh\fP
-.br
-\f[CR]\ \ Groups\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ sbuild\fP
-.br
-\f[CR]\ \ Root\ Users\fP
-.br
-\f[CR]\ \ Root\ Groups\ \ \ \ \ \ \ \ \ \ \ \ root sbuild\fP
-.br
-\f[CR]\ \ Aliases\fP
-.br
-\f[CR]\ \ Environment\ Filter\ \ \ \ \ ^(BASH_ENV|CDPATH|ENV|HOSTALIASES|I\fP
-.br
-\f[CR]FS|KRB5_CONFIG|KRBCONFDIR|KRBTKFILE|KRB_CONF|LD_.*|LOCALDOMA\fP
-.br
-\f[CR]IN|NLSPATH|PATH_LOCALE|RES_OPTIONS|TERMINFO|TERMINFO_DIRS|TE\fP
-.br
-\f[CR]RMPATH)$\fP
-.br
-\f[CR]\ \ Run\ Setup\ Scripts\ \ \ \ \ \ true\fP
-.br
-\f[CR]\ \ Script\ Configuration\ \ \ script\-defaults\fP
-.br
-\f[CR]\ \ Session\ Managed\ \ \ \ \ \ \ \ true\fP
-.br
-\f[CR]\ \ Personality\ \ \ \ \ \ \ \ \ \ \ \ linux\fP
-.br
-\f[CR]\ \ Device\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ /dev/hda_vg/sid_chroot\fP
-.br
-\f[CR]\ \ Mount\ Options\ \ \ \ \ \ \ \ \ \ \-o atime,async,user_xattr\fP
-.br
-\f[CR]\ \ Source\ Users\fP
-.br
-\f[CR]\ \ Source\ Groups\ \ \ \ \ \ \ \ \ \ root rleigh\fP
-.br
-\f[CR]\ \ Source\ Root\ Users\fP
-.br
-\f[CR]\ \ Source\ Root\ Groups\ \ \ \ \ root rleigh\fP
-.br
-\f[CR]\ \ LVM\ Snapshot\ Options\ \ \ \-\-size 2G \-c 128\fP
+.EX
+% \f[CB]schroot \-i \-c sid\-snap\fP\[CR]
+ \[em]\[em]\[em] Chroot \[em]\[em]\[em]
+ Name sid\-snap
+ Description Debian sid snapshot
+ Type lvm\-snapshot
+ Priority 3
+ Users maks rleigh
+ Groups sbuild
+ Root Users
+ Root Groups root sbuild
+ Aliases
+ Environment Filter ^(BASH_ENV|CDPATH|ENV|HOSTALIASES|I\\
+FS|KRB5_CONFIG|KRBCONFDIR|KRBTKFILE|KRB_CONF|LD_.*|LOCALDOMA\\
+IN|NLSPATH|PATH_LOCALE|RES_OPTIONS|TERMINFO|TERMINFO_DIRS|TE\\
+RMPATH)$
+ Run Setup Scripts true
+ Script Configuration script\-defaults
+ Session Managed true
+ Personality linux
+ Device /dev/hda_vg/sid_chroot
+ Mount Options \-o atime,async,user_xattr
+ Source Users
+ Source Groups root rleigh
+ Source Root Users
+ Source Root Groups root rleigh
+ LVM Snapshot Options \-\-size 2G \-c 128
+.EE
.PP
Note that the \fISession Managed\fP option is set to \[oq]true\[cq]. This is a
requirement in order to use session management, and is supported by most chroot
types. Next, we will create a new session:
.PP
-\f[CR]%\ \f[CB]schroot \-b \-c sid\-snap\fP\fP\[CR]
-.br
-\f[CR]sid\-snap\-46195b04\-0893\-49bf\-beb8\-0d4ccc899f0f\fP
+.EX
+% \f[CB]schroot \-b \-c sid\-snap\fP\[CR]
+sid\-snap\-46195b04\-0893\-49bf\-beb8\-0d4ccc899f0f
+.EE
.PP
The session ID of the newly-created session is returned on standard output. It
is common to store it like this:
.PP
-\f[CR]%\ \f[CB]SESSION=$(schroot \-b \-c sid\-snap)\fP\fP\[CR]
-.br
-\f[CR]%\ \f[CB]echo $SESSION\fP\fP\[CR]
-.br
-\f[CR]sid\-snap\-46195b04\-0893\-49bf\-beb8\-0d4ccc899f0f\fP
+.EX
+% \f[CB]SESSION=$(schroot \-b \-c sid\-snap)\fP\[CR]
+% \f[CB]echo $SESSION\fP\[CR]
+sid\-snap\-46195b04\-0893\-49bf\-beb8\-0d4ccc899f0f
+.EE
.PP
The session may be used just like any normal chroot. This is what the session
looks like:
.PP
-\f[CR]%\ \f[CB]schroot\ \-i\ \-c\ sid\-snap\-46195b04\-0893\-49bf\-beb8\-0d4ccc899f0f\fP\fP\[CR]
-.br
-\f[CR]\ \ \[em]\[em]\[em]\ Session\ \[em]\[em]\[em]\fP
-.br
-\f[CR]\ \ Name\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ sid\-snap\-46195b04\-0893\-49bf\-beb8\-0d\fP
-.br
-\f[CR]4ccc899f0f\fP
-.br
-\f[CR]\ \ Description\ \ \ \ \ \ \ \ \ \ \ \ Debian sid snapshot\fP
-.br
-\f[CR]\ \ Type\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ lvm\-snapshot\fP
-.br
-\f[CR]\ \ Priority\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ 3\fP
-.br
-\f[CR]\ \ Users\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ maks rleigh\fP
-.br
-\f[CR]\ \ Groups\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ sbuild\fP
-.br
-\f[CR]\ \ Root\ Users\fP
-.br
-\f[CR]\ \ Root\ Groups\ \ \ \ \ \ \ \ \ \ \ \ root sbuild\fP
-.br
-\f[CR]\ \ Aliases\fP
-.br
-\f[CR]\ \ Environment\ Filter\ \ \ \ \ ^(BASH_ENV|CDPATH|ENV|HOSTALIASES|I\fP
-.br
-\f[CR]FS|KRB5_CONFIG|KRBCONFDIR|KRBTKFILE|KRB_CONF|LD_.*|LOCALDOMA\fP
-.br
-\f[CR]IN|NLSPATH|PATH_LOCALE|RES_OPTIONS|TERMINFO|TERMINFO_DIRS|TE\fP
-.br
-\f[CR]RMPATH)$\fP
-.br
-\f[CR]\ \ Run\ Setup\ Scripts\ \ \ \ \ \ true\fP
-.br
-\f[CR]\ \ Script\ Configuration\ \ \ script\-defaults\fP
-.br
-\f[CR]\ \ Session\ Managed\ \ \ \ \ \ \ \ true\fP
-.br
-\f[CR]\ \ Personality\ \ \ \ \ \ \ \ \ \ \ \ linux\fP
-.br
-\f[CR]\ \ Mount\ Location\ \ \ \ \ \ \ \ \ /var/lib/schroot/mount/sid\-snap\-461\fP
-.br
-\f[CR]95b04\-0893\-49bf\-beb8\-0d4ccc899f0f\fP
-.br
-\f[CR]\ \ Path\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ /var/lib/schroot/mount/sid\-snap\-461\fP
-.br
-\f[CR]95b04\-0893\-49bf\-beb8\-0d4ccc899f0f\fP
-.br
-\f[CR]\ \ Mount\ Device\ \ \ \ \ \ \ \ \ \ \ /dev/hda_vg/sid\-snap\-46195b04\-0893\-\fP
-.br
-\f[CR]49bf\-beb8\-0d4ccc899f0f\fP
-.br
-\f[CR]\ \ Device\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ /dev/hda_vg/sid_chroot\fP
-.br
-\f[CR]\ \ Mount\ Options\ \ \ \ \ \ \ \ \ \ \-o\ atime,async,user_xattr\fP
-.br
-\f[CR]\ \ Source\ Users\fP
-.br
-\f[CR]\ \ Source\ Groups\ \ \ \ \ \ \ \ \ \ root\ rleigh\fP
-.br
-\f[CR]\ \ Source\ Root\ Users\fP
-.br
-\f[CR]\ \ Source\ Root\ Groups\ \ \ \ \ root\ rleigh\fP
-.br
-\f[CR]\ \ LVM\ Snapshot\ Device\ \ \ \ /dev/hda_vg/sid\-snap\-46195b04\-0893\-\fP
-.br
-\f[CR]49bf\-beb8\-0d4ccc899f0f\fP
-.br
-\f[CR]\ \ LVM\ Snapshot\ Options\ \ \ \-\-size\ 2G\ \-c\ 128\fP
+.EX
+% \f[CB]schroot \-i \-c sid\-snap\-46195b04\-0893\-49bf\-beb8\-0d4ccc899f0f\fP\[CR]
+ \[em]\[em]\[em] Session \[em]\[em]\[em]
+ Name sid\-snap\-46195b04\-0893\-49bf\-beb8\-0d\\
+4ccc899f0f
+ Description Debian sid snapshot
+ Type lvm\-snapshot
+ Priority 3
+ Users maks rleigh
+ Groups sbuild
+ Root Users
+ Root Groups root sbuild
+ Aliases
+ Environment Filter ^(BASH_ENV|CDPATH|ENV|HOSTALIASES|I\\
+FS|KRB5_CONFIG|KRBCONFDIR|KRBTKFILE|KRB_CONF|LD_.*|LOCALDOMA\\
+IN|NLSPATH|PATH_LOCALE|RES_OPTIONS|TERMINFO|TERMINFO_DIRS|TE\\
+RMPATH)$
+ Run Setup Scripts true
+ Script Configuration script\-defaults
+ Session Managed true
+ Personality linux
+ Mount Location /var/lib/schroot/mount/sid\-snap\-461\\
+95b04\-0893\-49bf\-beb8\-0d4ccc899f0f
+ Path /var/lib/schroot/mount/sid\-snap\-461\\
+95b04\-0893\-49bf\-beb8\-0d4ccc899f0f
+ Mount Device /dev/hda_vg/sid\-snap\-46195b04\-0893\-\\
+49bf\-beb8\-0d4ccc899f0f
+ Device /dev/hda_vg/sid_chroot
+ Mount Options \-o atime,async,user_xattr
+ Source Users
+ Source Groups root rleigh
+ Source Root Users
+ Source Root Groups root rleigh
+ LVM Snapshot Device /dev/hda_vg/sid\-snap\-46195b04\-0893\-\\
+49bf\-beb8\-0d4ccc899f0f
+ LVM Snapshot Options \-\-size 2G \-c 128
+.EE
.PP
Now the session has been created, commands may be run in it:
.PP
-\f[CR]%\ \f[CB]schroot \-r \-c sid\-snap\-46195b04\-0893\-49bf\-beb8\-0d4ccc899f0f \-\- uname \-sr\fP\fP\[CR]
-.br
-\f[CR]I: [sid\-snap\-46195b04\-0893\-49bf\-beb8\-0d4ccc899f0f chroot] Running command: \[lq]uname \-sr\[rq]\fP
-.br
-\f[CR]Linux 2.6.18\-3\-powerpc\fP
-.br
-\f[CR]%\ \f[CB]schroot \-r \-c $SESSION \-\- uname \-sr\fP\fP\[CR]
-.br
-\f[CR]I: [sid\-snap\-fe170af9\-d9be\-4800\-b1bd\-de275858b938 chroot] Running command: \[lq]uname \-sr\[rq]\fP
-.br
-\f[CR]Linux 2.6.18\-3\-powerpc\fP
+.EX
+% \f[CB]schroot \-r \-c sid\-snap\-46195b04\-0893\-49bf\-beb8\-0d4ccc899f0f \-\- \\
+ uname \-sr\fP\[CR]
+I: [sid\-snap\-46195b04\-0893\-49bf\-beb8\-0d4ccc899f0f chroot] Running \\
+command: \[lq]uname \-sr\[rq]
+Linux 2.6.18\-3\-powerpc
+% \f[CB]schroot \-r \-c $SESSION \-\- uname \-sr\fP\[CR]
+I: [sid\-snap\-fe170af9\-d9be\-4800\-b1bd\-de275858b938 chroot] Running \\
+command: \[lq]uname \-sr\[rq]
+Linux 2.6.18\-3\-powerpc
+.EE
.PP
When all the commands to run in the session have been performed, the session
may be ended:
.PP
-\f[CR]%\ \f[CB]schroot \-e \-c sid\-snap\-46195b04\-0893\-49bf\-beb8\-0d4ccc899f0f\fP\fP\[CR]
-.br
-\f[CR]%\ \f[CB]schroot \-e \-c $SESSION\fP\fP\[CR]
+.EX
+\f[CR]% \f[CB]schroot \-e \-c sid\-snap\-46195b04\-0893\-49bf\-beb8\-0d4ccc899f0f\fP\fP\[CR]
+\f[CR]% \f[CB]schroot \-e \-c $SESSION\fP\fP\[CR]
+.EE
.PP
Finally, the session names can be long and unwieldy. A name may be specified
instead of using the automatically generated session ID:
.PP
-\f[CR]%\ \f[CB]schroot \-b \-c sid\-snap \-n my\-session\-name\fP\fP\[CR]
-.br
+.EX
+\f[CR]% \f[CB]schroot \-b \-c sid\-snap \-n my\-session\-name\fP\fP\[CR]
\f[CR]my\-session\-name\fP
+.EE
.SH TROUBLESHOOTING
If something is not working, and it's not clear from the error messages what is
wrong, try using the \fB\-\-debug=\fP\fIlevel\fP option to turn on debugging
diff --git a/man/schroot.conf.5.man b/man/schroot.conf.5.man
index 907d71d2..c688d49d 100644
--- a/man/schroot.conf.5.man
+++ b/man/schroot.conf.5.man
@@ -15,7 +15,7 @@
.\" <http://www.gnu.org/licenses/>.
.\"
.so config.man
-.TH SCHROOT.CONF 5 "@RELEASE_DATE_S@" "Version @VERSION@" "Debian sbuild"
+.TH SCHROOT.CONF 5 "\*[RELEASE_DATE]" "Version \*[VERSION]" "Debian sbuild"
.SH NAME
schroot.conf \- chroot definition file for schroot
.SH DESCRIPTION
@@ -104,7 +104,7 @@ chroot name itself.
\f[CBI]script\-config=\fP\f[CI]filename\fP
The behaviour of the chroot setup scripts may be customised on a per-chroot
basis by providing a shell script which the scripts will source. The filename
-is relative to \fI@SCHROOT_SYSCONF_DIR@\fP. The default filename is
+is relative to \fI\*[SCHROOT_SYSCONF_DIR]\fP. The default filename is
\[oq]default/config\[cq]. Alternatives are \[oq]minimal/config\[cq] (minimal
configuration), \[oq]desktop/config\[cq] (for running desktop applications in
the chroot, making more functionality from the host system available in the
@@ -372,29 +372,29 @@ for a complete variable list.
.TP
\f[CBI]union\-overlay\-directory\fP\f[CI]=directory\fP
Specify the directory where the writeable overlay session directories will be
-created. The default is \[oq]@SCHROOT_OVERLAY_DIR@\[cq].
+created. The default is \[oq]\*[SCHROOT_OVERLAY_DIR]\[cq].
.TP
\f[CBI]union\-underlay\-directory\fP\f[CI]=directory\fP
Specify the directory where the read-only underlying directories will be
-created. The default is \[oq]@SCHROOT_UNDERLAY_DIR@\[cq].
+created. The default is \[oq]\*[SCHROOT_UNDERLAY_DIR]\[cq].
.SS Localisation
.PP
Some keys may be localised in multiple languages. This is achieved by adding
the locale name in square brackets after the key name. For example:
-.br
.RS
-\f[CR]description[en_GB]=\f[CI]British English translation\fP\fP
-.br
+.EX
+description[en_GB]=\f[CI]British English translation\fP
+.EE
.RE
.PP
This will localise the \f[CI]description\fP key for the en_GB locale.
.RS
-\f[CR]description[fr]=\f[CI]French translation\fP\fP
-.br
+.EX
+description[fr]=\f[CI]French translation\fP
+.EE
.RE
.PP
This will localise the \f[CI]description\fP key for all French locales.
-.br
.SH CHROOT NAMES
A number of characters or words are not permitted in a chroot name, session
name or configuration filename. The name may not contain a leading period
@@ -465,102 +465,63 @@ filesystem). The different profiles make different tradeoffs, and it is
important that you assess which meets the security/usability tradeoff you
require.
.SH EXAMPLE
-\f[CR]# Sample configuration\fP
-.br
-\f[CR]\fP
-.br
-\f[CR][sid]\fP
-.br
-\f[CR]type=plain\fP
-.br
-\f[CR]description=Debian unstable\fP
-.br
-\f[CR]description[fr_FR]=Debian instable\fP
-.br
-\f[CR]directory=/srv/chroot/sid\fP
-.br
-\f[CR]priority=3\fP
-.br
-\f[CR]users=jim\fP
-.br
-\f[CR]groups=sbuild\fP
-.br
-\f[CR]root\-users=rleigh\fP
-.br
-\f[CR]aliases=unstable,default\fP
-.br
-\f[CR]\fP
-.br
-\f[CR][etch]\fP
-.br
-\f[CR]type=block\-device\fP
-.br
-\f[CR]description=Debian testing (32\-bit)\fP
-.br
-\f[CR]priority=2\fP
-.br
-\f[CR]groups=users\fP
-.br
-\f[CR]#groups=sbuild\-security\fP
-.br
-\f[CR]aliases=testing\fP
-.br
-\f[CR]device=/dev/hda_vg/etch_chroot\fP
-.br
-\f[CR]mount\-options=\-o atime\fP
-.br
-\f[CR]personality=linux32\fP
-.br
-\f[CR]\fP
-.br
-\f[CR][sid\-file]\fP
-.br
-\f[CR]type=file\fP
-.br
-\f[CR]description=Debian sid file\-based chroot\fP
-.br
-\f[CR]priority=3\fP
-.br
-\f[CR]groups=sbuild\fP
-.br
-\f[CR]file=/srv/chroots/sid.tar.gz\fP
-.br
-\f[CR]\fP
-.br
-\f[CR][sid\-snapshot]\fP
-.br
-\f[CR]type=lvm\-snapshot\fP
-.br
-\f[CR]description=Debian unstable LVM snapshot\fP
-.br
-\f[CR]priority=3\fP
-.br
-\f[CR]groups=sbuild\fP
-.br
-\f[CR]users=rleigh\fP
-.br
-\f[CR]source\-root\-users=rleigh\fP
-.br
-\f[CR]source\-root\-groups=admin\fP
-.br
-\f[CR]device=/dev/hda_vg/sid_chroot\fP
-.br
-\f[CR]mount\-options=\-o atime,sync,user_xattr\fP
-.br
-\f[CR]lvm\-snapshot\-options=\-\-size 2G\fP
+.EX
+# Sample configuration
+
+[sid]
+type=plain
+description=Debian unstable
+description[fr_FR]=Debian instable
+directory=/srv/chroot/sid
+priority=3
+users=jim
+groups=sbuild
+root\-users=rleigh
+aliases=unstable,default
+
+[etch]
+type=block\-device
+description=Debian testing (32\-bit)
+priority=2
+groups=users
+#groups=sbuild\-security
+aliases=testing
+device=/dev/hda_vg/etch_chroot
+mount\-options=\-o atime
+personality=linux32
+
+[sid\-file]
+type=file
+description=Debian sid file\-based chroot
+priority=3
+groups=sbuild
+file=/srv/chroots/sid.tar.gz
+
+[sid\-snapshot]
+type=lvm\-snapshot
+description=Debian unstable LVM snapshot
+priority=3
+groups=sbuild
+users=rleigh
+source\-root\-users=rleigh
+source\-root\-groups=admin
+device=/dev/hda_vg/sid_chroot
+mount\-options=\-o atime,sync,user_xattr
+lvm\-snapshot\-options=\-\-size 2G
+.EE
.SH FILES
.SS Chroot definitions
.TP
-\f[BI]@SCHROOT_CONF@\fP
+\f[BI]\*[SCHROOT_CONF]\fP
The system-wide chroot definition file. This file must be owned by the root
user, and not be writable by other.
.TP
-\f[BI]@SCHROOT_CONF_CHROOT_D@\fP
+\f[BI]\*[SCHROOT_CONF_CHROOT_D]\fP
Additional chroot definitions may be placed in files under this directory.
-They are treated in exactly that same manner as \fI@SCHROOT_CONF@\fP. Each
+They are treated in exactly that same manner as \fI\*[SCHROOT_CONF]\fP. Each
file may contain one or more chroot definitions.
.SS Setup script configuration
-The directory \f[BI]@SCHROOT_SYSCONF_DIR@/default\fP contains the default
+The directory \f[BI]\*[SCHROOT_SYSCONF_DIR]/default\fP contains the default
settings used by setup scripts.
.TP
\f[BI]config\fP
@@ -568,24 +529,24 @@ Main configuration file read by setup scripts. The format of this file is
described in
.BR schroot\-script\-config (5).
This is the default value for the \f[CI]script\-config\fP key. Note that this
-was formerly named \fI@SCHROOT_SYSCONF_DIR@/script\-defaults\fP. The following
+was formerly named \fI\*[SCHROOT_SYSCONF_DIR]/script\-defaults\fP. The following
files are referenced by default:
.TP
\f[BI]copyfiles\fP
A list of files to copy into the chroot from the host system. Note that this
-was formerly named \fI@SCHROOT_SYSCONF_DIR@/copyfiles\-defaults\fP.
+was formerly named \fI\*[SCHROOT_SYSCONF_DIR]/copyfiles\-defaults\fP.
.TP
\f[BI]fstab\fP
A file in the format decribed in
.BR fstab (5),
used to mount filesystems inside the chroot. The mount location is relative to
the root of the chroot. Note that this was formerly named
-\fI@SCHROOT_SYSCONF_DIR@/mount\-defaults\fP.
+\fI\*[SCHROOT_SYSCONF_DIR]/mount\-defaults\fP.
.TP
\f[BI]nssdatabases\fP
System databases (as described in \fI/etc/nsswitch.conf\fP on GNU/Linux
systems) to copy into the chroot from the host. Note that this was formerly
-named \fI@SCHROOT_SYSCONF_DIR@/nssdatabases\-defaults\fP.
+named \fI\*[SCHROOT_SYSCONF_DIR]/nssdatabases\-defaults\fP.
.so authors.man
.so copyright.man
.SH SEE ALSO