|
Unix VPS
Support
FAQ
Network
Miscellaneous
|
| cbsd-jdescr(8) | FreeBSD System Manager's Manual | cbsd-jdescr(8) |
NAME
cbsd jdescr —
Jail description and notes.
SYNOPSIS
cbsd jdescr |
[mode=update]
[jname=<jail-name>]
[editor=<editor>]
[--help]
|
DESCRIPTION
Thecbsd jdescr command can display and store jail
description or summary. It is possible to store all kinds of information about
the jail especially as the collection of jails grows. cbsd
jdescr without options displays description of all local jails.
The options are as follows:
jname=<jail-name>mode=update- Update information about <jail-name>.
editor=<editor>- Use a different editor.
--help- Show simple usage instructions.
Descriptions for each jail are stored in a text file residing at $workdir/jails-system/$jname/descr, where jname is the name of the jail. When moving or copying a jail with jcoldmigrate, jclone, jimport/export, the description will be preserved.
ENVIRONMENT
By default, CBSD displays text in color (using escape sequences ANSII). If for some reason the color is unpleasant, or you want to use output from CBSD utilities in your scripts, you can disable the color through the environment variable NOCOLOR=1. For example:% env NOCOLOR=1 cbsd
jdescrFILES
- $workdir/jails-system/$jname/descr
- Place where jail descriptions are stored.
EXIT STATUS
Thecbsd jdescr utility exits 0 on success,
and >0 if an error occurs.
EXAMPLES
- List all local jail descriptions:
-
cbsd jdescr jail1 { This is some description for Jail1. } - Update information about jail using the default editor:
-
cbsd jdescrjname=jail1mode=update Jail1 This Jail is used to test things. Created on: 20161129
DIAGNOSTICS
To enable debugging via sh xtrace and trace all operations, use --debug argument after the CBSD command, for example:% env NOCOLOR=1 cbsd
jdescr
--debugSEE ALSO
cbsd-jconfig(8) cbsd-jset(8)AUTHORS
Oleg Ginzburg <olevole@olevole.ru>| December 10, 2016 | FreeBSD 13.1-RELEASE |
Visit the GSP FreeBSD Man Page Interface.
Output converted with ManDoc.