* bin/schroot/script-defaults: Reorder variables.

* bin/schroot/schroot.1.in, bin/schroot/schroot.conf.5.in,
  bin/schroot/schroot-setup.5.in: Update copyright, hyphenation and
  references.
* doc/Makefile.am (PS_DEPS): Add schroot-script-config.5.
* bin/schroot/Makefile.am (man_MANS): Add schroot-script-config.5.
* configure.ac: Add bin/schroot/schroot-script-config.5
* bin/schroot/schroot-script-config.5.in: New manual page to
  document file format of script-config option.

7 files changed, 100 insertions, 25 deletions

diff --git a/bin/schroot/.gitignore b/bin/schroot/.gitignore
index 35c2a741..9d4efb5f 100644
--- a/bin/schroot/.gitignore
+++ b/bin/schroot/.gitignore
@@ -1,4 +1,5 @@
 schroot
 schroot.1
 schroot-setup.5
+schroot-script-config.5
 schroot.conf.5
diff --git a/bin/schroot/Makefile.am b/bin/schroot/Makefile.am
index ac64fcce..2dec9b9f 100644
--- a/bin/schroot/Makefile.am
+++ b/bin/schroot/Makefile.am
@@ -52,7 +52,11 @@ schroot_LDADD = libschroot.la
 pkgsysconfdir = $(PACKAGE_SYSCONF_DIR)
 pkgsysconf_DATA = schroot.conf mount-defaults script-defaults
 
-man_MANS = schroot.1 schroot-setup.5 schroot.conf.5
+man_MANS =			\
+	schroot.1		\
+	schroot-setup.5		\
+	schroot.conf.5		\
+	schroot-script-config.5
 
 EXTRA_DIST =			\
 	$(pkgsysconf_DATA)
diff --git a/bin/schroot/schroot-script-config.5.in b/bin/schroot/schroot-script-config.5.in
new file mode 100644
index 00000000..1dd7a3b3
--- /dev/null
+++ b/bin/schroot/schroot-script-config.5.in
@@ -0,0 +1,68 @@
+.\" Copyright © 2005-2008  Roger Leigh <rleigh@debian.org>
+.\"
+.\" schroot 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.
+.\"
+.\" schroot is distributed in the hope that it will be useful, but
+.\" WITHOUT ANY WARRANTY; without even the implied warranty of
+.\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+.\" General Public License for more details.
+.\"
+.\" You should have received a copy of the GNU General Public License
+.\" along with this program.  If not, see
+.\" <http://www.gnu.org/licenses/>.
+.\"
+.TH SCHROOT-SCRIPT-CONFIG 5 "@RELEASE_DATE@" "Version @VERSION@" "Debian sbuild"
+.SH NAME
+schroot-script-config \[em] schroot chroot setup script configuration
+.SH DESCRIPTION
+\fBschroot\fP uses scripts to to set up and then clean up the chroot
+environment.  These scripts may be customised using the \f[CI]script\-config\fP
+key in \fI@SCHROOT_CONF@\fP.  This key specifies a file which the setup scripts
+will source when they are run.  The file is a Bourne shell script, and in
+consequence may contain any valid shell code, in addition to simple variable
+assignments.  This will, for example, allow behaviour to be customised
+according to the specific chroot type or name.
+.SH ENVIRONMENT
+The environment is the same as for all setup scripts, described in
+.BR schroot-setup (5).
+.SH VARIABLES
+The following variables may be set to configure setup script behaviour.  Note
+that new variables may be added in future releases.  Third-party extensions to
+schroot which add their own setup scripts may add additional variables which
+are not documented here; consult the extension documentation for further
+details.
+.TP
+FSTAB
+The filesystem table file to be used to mount filesystems within the chroot.
+The format of this file is the same as for \fI/etc/fstab\fP, documented in
+.BR fstab (5).
+The only difference is that the mountpoint path \fIfs_dir\fP is relative to the
+chroot, rather than the root.
+.TP
+SBUILD
+Set to \[oq]true\[cq] to enable sbuild support in the chroot, or
+\[oq]false\[cq] to disable.
+.SH AUTHORS
+Roger Leigh.
+.SH COPYRIGHT
+Copyright \(co 2005\-2008  Roger Leigh \f[CR]<rleigh@debian.org>\fP
+.PP
+\fBschroot\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.
+.SH SEE ALSO
+.BR sbuild (1),
+.BR schroot (1),
+.BR sh (1),
+.BR schroot.conf (5),
+.BR schroot\-setup (5).
+.\"#
+.\"# The following sets edit modes for GNU EMACS
+.\"# Local Variables:
+.\"# mode:nroff
+.\"# fill-column:79
+.\"# End:
diff --git a/bin/schroot/schroot-setup.5.in b/bin/schroot/schroot-setup.5.in
index a203bb9d..e5a02fb1 100644
--- a/bin/schroot/schroot-setup.5.in
+++ b/bin/schroot/schroot-setup.5.in
@@ -1,4 +1,4 @@
-.\" Copyright © 2005-2007  Roger Leigh <rleigh@debian.org>
+.\" Copyright © 2005-2008  Roger Leigh <rleigh@debian.org>
 .\"
 .\" schroot is free software: you can redistribute it and/or modify it
 .\" under the terms of the GNU General Public License as published by
@@ -14,9 +14,9 @@
 .\" along with this program.  If not, see
 .\" <http://www.gnu.org/licenses/>.
 .\"
-.TH SCHROOT-SETUP 5 "@RELEASE_DATE@" "Version @VERSION@" "Debian sbuild"
+.TH SCHROOT\-SETUP 5 "@RELEASE_DATE@" "Version @VERSION@" "Debian sbuild"
 .SH NAME
-schroot-setup \[em] schroot chroot setup scripts
+schroot\-setup \[em] schroot chroot setup scripts
 .SH DESCRIPTION
 \fBschroot\fP uses scripts to to set up and then clean up the chroot
 environment.  The directories \f[BI]@SCHROOT_CONF_SETUP_D@\fP and
@@ -52,8 +52,7 @@ failure.
 Note that the scripts should be \fIidempotent\fP.  They \fBmust\fP be
 idempotent during the \[oq]exec\-stop\[cq] and \[oq]setup\-stop\[cq] phases,
 because they may be run more than once.
-.SH
-ENVIRONMENT
+.SH ENVIRONMENT
 .SS General variables
 .TP
 AUTH_USER
@@ -176,16 +175,17 @@ Print debugging diagnostics and perform basic sanity checking.
 .SH AUTHORS
 Roger Leigh.
 .SH COPYRIGHT
-Copyright \(co 2005\-2007  Roger Leigh \f[CR]<rleigh@debian.org>\fP
+Copyright \(co 2005\-2008  Roger Leigh \f[CR]<rleigh@debian.org>\fP
 .PP
 \fBschroot\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.
 .SH SEE ALSO
-.BR sbuild (1),
+.BR schroot (1),
 .BR schroot.conf (5),
-.BR run-parts (8).
+.BR schroot\-script\-config (5),
+.BR run\-parts (8).
 .\"#
 .\"# The following sets edit modes for GNU EMACS
 .\"# Local Variables:
diff --git a/bin/schroot/schroot.1.in b/bin/schroot/schroot.1.in
index d04b6ff2..b3ba62c9 100644
--- a/bin/schroot/schroot.1.in
+++ b/bin/schroot/schroot.1.in
@@ -1,4 +1,4 @@
-.\" Copyright © 2005-2007  Roger Leigh <rleigh@debian.org>
+.\" Copyright © 2005-2008  Roger Leigh <rleigh@debian.org>
 .\" Copyright © 2006       Andreas Bombe <aeb@debian.org>
 .\"
 .\" schroot is free software: you can redistribute it and/or modify it
@@ -510,7 +510,7 @@ PAM configuration.
 .SH AUTHORS
 Roger Leigh.
 .SH COPYRIGHT
-Copyright \(co 2005\-2007  Roger Leigh \f[CR]<rleigh@debian.org>\fP
+Copyright \(co 2005\-2008  Roger Leigh \f[CR]<rleigh@debian.org>\fP
 .PP
 \fBschroot\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
@@ -520,7 +520,7 @@ version.
 .BR dchroot (1),
 .BR sbuild (1),
 .BR chroot (2),
-.BR schroot-setup (5),
+.BR schroot\-setup (5),
 .BR schroot.conf (5).
 .\"#
 .\"# The following sets edit modes for GNU EMACS
diff --git a/bin/schroot/schroot.conf.5.in b/bin/schroot/schroot.conf.5.in
index db06e68e..52c91723 100644
--- a/bin/schroot/schroot.conf.5.in
+++ b/bin/schroot/schroot.conf.5.in
@@ -1,4 +1,4 @@
-.\" Copyright © 2005-2007  Roger Leigh <rleigh@debian.org>
+.\" Copyright © 2005-2008  Roger Leigh <rleigh@debian.org>
 .\"
 .\" schroot is free software: you can redistribute it and/or modify it
 .\" under the terms of the GNU General Public License as published by
@@ -19,7 +19,7 @@
 schroot.conf \[em] chroot definition file for schroot
 .SH DESCRIPTION
 \f[BI]schroot.conf\fP is a plain UTF-8 text file, describing the chroots
-available for use with sbuild.
+available for use with schroot.
 .PP
 Comments are introduced following a \[oq]\f[CR]\[sh]\fP\[cq] (\[lq]hash\[rq])
 character at the beginning of a line, or following any other text.  All text
@@ -56,8 +56,7 @@ whether a distribution is older than another.  For example, \[lq]oldstable\[rq]
 and \[lq]oldstable-security\[rq] might be \[oq]0\[cq], while \[lq]stable\[rq]
 and \[lq]stable-security\[rq] are \[oq]1\[cq], \[lq]testing\[rq] is \[oq]2\[cq]
 and \[lq]unstable\[rq] is \[oq]3\[cq].  The values are not important, but the
-difference between them is.  This is used by sbuild when using the schroot
-chroot mode.
+difference between them is.  This is used by sbuild and wanna-build.
 .TP
 \f[CBI]users=\fP\f[CI]user1,user2,...\fP
 A comma-separated list of users which are allowed access to the chroot.  If
@@ -99,9 +98,9 @@ the chroot environment.  If enabled for a \[oq]plain\[cq] or
 (not true session management, because it does not make a copy of the chroot).
 If your chroots are exclusively controlled by schroot, set to \[oq]true\[cq].
 .TP
-\f[CBI]run\-exec\-scripts=\fP\f[CI]true\fP|\f[CI]false\fP
-Set whether chroot execution scripts will be run.  The default is the same as
-the default for the \f[CI]run-setup-scripts\fP key.  This option was called
+\f[CBI]run\-exec\-scripts=\fP\f[CI]true\fP|\f[CI]false\fP Set whether chroot
+execution scripts will be run.  The default is the same as the default for the
+\f[CI]run\-setup\-scripts\fP key.  This option was called
 \f[CI]run\-session\-scripts\fP in versions prior to 0.2.5.
 .TP
 \f[CBI]script\-config=\fP\f[CI]filename\fP
@@ -113,7 +112,8 @@ copy this script and amend the copy; or alter the original to set the defaults
 for all chroots.  Settings for specific chroots may also be set in a single
 script by using conditionals checking the chroot name and/or type.  Note that
 the setup script will be sourced once for each and every setup and exec script
-invocation, and must be idempotent.
+invocation, and must be idempotent.  The file format is documented in
+.BR schroot-script-config (5).
 .TP
 \f[CBI]command\-prefix=\fP\f[CI]command,option1,option2,...\fP
 A comma-separated list of a command and the options for the command.  This
@@ -381,7 +381,7 @@ user, and not be writable by other.
 .SH AUTHORS
 Roger Leigh.
 .SH COPYRIGHT
-Copyright \(co 2005\-2007  Roger Leigh \f[CR]<rleigh@debian.org>\fP
+Copyright \(co 2005\-2008  Roger Leigh \f[CR]<rleigh@debian.org>\fP
 .PP
 \fBschroot\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
@@ -390,6 +390,7 @@ version.
 .SH SEE ALSO
 .BR sbuild (1),
 .BR schroot (1),
+.BR schroot\-script\-config (5),
 .BR mount (8).
 .\"#
 .\"# The following sets edit modes for GNU EMACS
diff --git a/bin/schroot/script-defaults b/bin/schroot/script-defaults
index f27c14f6..e7744577 100644
--- a/bin/schroot/script-defaults
+++ b/bin/schroot/script-defaults
@@ -1,4 +1,8 @@
-# Default settings for chroot setup and exec scripts
+# Default settings for chroot setup and exec scripts.
+# See schroot-script-config(5) for further details.
+
+# Filesystems to mount
+FSTAB="/etc/schroot/mount-defaults"
 
 # Is sbuild installed?
 if [ -x /usr/bin/sbuild ]; then
@@ -6,6 +10,3 @@ if [ -x /usr/bin/sbuild ]; then
 else
   SBUILD="false"
 fi
-
-# Filesystems to mount
-FSTAB="/etc/schroot/mount-defaults"
\ No newline at end of file