summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorRoger Leigh <rleigh@debian.org>2010-12-05 21:43:29 +0000
committerRoger Leigh <rleigh@debian.org>2010-12-05 21:52:24 +0000
commit982df15108871e01f85a51c4723c08d9ab8b3795 (patch)
tree5a56f2e6ccf69fcf5f95da950e91fd70db41e525
parent26204d837ecf2e938143b3212050dd445f653537 (diff)
downloadschroot-982df15108871e01f85a51c4723c08d9ab8b3795.tar.gz
man: Document chroot naming restrictions
-rw-r--r--man/schroot.1.in4
-rw-r--r--man/schroot.conf.5.in7
2 files changed, 9 insertions, 2 deletions
diff --git a/man/schroot.1.in b/man/schroot.1.in
index 8c7f4fde..d08a7a76 100644
--- a/man/schroot.1.in
+++ b/man/schroot.1.in
@@ -210,7 +210,9 @@ option.
Name a session. The specified \fIsession-name\fP replaces the default session
name containing an automatically-generated session ID. The session name must
not contain a namespace qualifier, since sessions are always created within the
-\[oq]session:\[cq] namespace.
+\[oq]session:\[cq] namespace. The session name is also subject to the chroot
+naming restrictions documented in
+.BR schroot.conf (5).
.TP
.BR \-f ", " \-\-force
Force a session operation, even if it would otherwise fail. This may be used
diff --git a/man/schroot.conf.5.in b/man/schroot.conf.5.in
index fbab61cc..51f109a3 100644
--- a/man/schroot.conf.5.in
+++ b/man/schroot.conf.5.in
@@ -37,6 +37,10 @@ For example,
.IP
\f[CR]\[lB]sid\[rB]
.PP
+The name may not contain a leading period (\[oq].\[cq]). The characters
+\[oq]:\[cq] (colon), \[oq],\[cq] (comma) and \[oq]/\[cq] (forward slash) are
+not permitted anywhere in the name.
+.PP
This is then followed by several key-value pairs, one per line:
.TP
\f[CBI]type=\fP\f[CI]type\fP
@@ -94,7 +98,8 @@ password). See the section \[lq]\fISecurity\fP\[rq] below.
\f[CBI]aliases=\fP\f[CI]alias1,alias2,...\fP
A comma-separated list of aliases (alternate names) for this chroot. For
example, a chroot named \[lq]sid\[rq] might have an \[oq]unstable\[cq] alias
-for convenience.
+for convenience. Aliases are subject to the same naming restrictions as the
+chroot name itself.
.TP
\f[CBI]run\-setup\-scripts=\fP\f[CI]true\fP|\f[CI]false\fP
Set whether chroot setup scripts will be run. The default is to run setup