diff --git a/doc/sphinx/man/kea-admin.8.rst b/doc/sphinx/man/kea-admin.8.rst index dc55dfd9d4..1f33d25029 100644 --- a/doc/sphinx/man/kea-admin.8.rst +++ b/doc/sphinx/man/kea-admin.8.rst @@ -20,9 +20,9 @@ Synopsis Description ~~~~~~~~~~~ -``kea-admin`` is a shell script which offers database maintenance. In +``kea-admin`` is a shell script that offers database maintenance. In particular, it features database initialization, database version -checking, and database schema upgrade. +checking, and database schema upgrading. Arguments ~~~~~~~~~ @@ -30,64 +30,64 @@ Arguments ``command`` Specifies the command to be issued to the servers. It can be one of the following: - **db-init** + ``db-init`` Initializes a new database schema. This is useful during a new Kea installation. The database is initialized to the latest version supported by the version of the software being installed. - **db-version** + ``db-version`` Reports the database backend version number. This is not necessarily - equal to the Kea version number as each backend has its own + equal to the Kea version number, as each backend has its own versioning scheme. - **db-upgrade** + ``db-upgrade`` Conducts a database schema upgrade. This is useful when upgrading Kea. - **lease-dump** - Dumps the contents of the lease database (for MySQL, PostgreSQL, - or CQL backends) to a CSV (comma-separated values) text file. + ``lease-dump`` + Dumps the contents of the lease database (for MySQL or PostgreSQL + backends) to a CSV (comma-separated values) text file. (Support for + the Cassandra backend has been deprecated.) The first line of the file contains the column names. This is meant to be used as a diagnostic tool, so it provides a portable, human-readable form of the lease data. - **stats-recount** - Recounts lease statistics for MySQL or PostgreSQL database. + ``stats-recount`` + Recounts lease statistics for a MySQL or PostgreSQL database. ``backend`` Specifies the backend type. Currently allowed backends are: memfile, - mysql, pgsql, and cql. + mysql, and pgsql; cql has been deprecated. ``-h|--host hostname`` - Specifies the hostname when connecting to a database. If not specified, - the default value of **localhost** is used. + Specifies the hostname when connecting to a database. + The default value is ``localhost``. ``-P|--port port`` Specifies the port when connecting to a database. If not specified, the default value chosen by the database client is used. ``-u|--user username`` - Specifies the username when connecting to a database. If not specified, - the default value of **keatest** is used. + Specifies the username when connecting to a database. + The default value is **keatest**. ``-p|--password password`` Specifies the password when connecting to a database. If only ``-p`` or ``--password`` is given, the user is prompted for a password. - If not specified at all, the **KEA_ADMIN_DB_PASSWORD** environment variable + If not specified at all, the ``KEA_ADMIN_DB_PASSWORD`` environment variable is checked for a value and used if it exists. - Otherwise the default value of **keatest** is used. + Otherwise the default value of ``keatest`` is used. ``-n|--name database-name`` - Specifies the name of the database to connect to. If not specified, the - default value of **keatest** is used. + Specifies the name of the database to connect to. The + default value is ``keatest``. ``-d|--directory script-directory`` Specifies the override scripts directory. That script is used during - upgrades, database initialization, and possibly other operations. If - not specified, the default value of ``(prefix)/share/kea/scripts/`` is - used. + upgrades, database initialization, and possibly other operations. + The default value is ``(prefix)/share/kea/scripts/``. ``-o|--output output_file`` - Specifies the file to which the lease data will be dumped. Required for lease-dump. + Specifies the file to which the lease data will be dumped. Required for ``lease-dump``. ``-v|--version`` Prints the ``kea-admin`` version and quits.