Man page of tw-backup(1)

tw-backup - backups/restores Textweiser databases

Shell tw-backup [db-opt] [opt] -B -o PATH

 tw-backup [db-opt] [opt] -R -i PATH

tw-backup can be utilized to backup and restore Textweiser databases.

These options are required in order to establish a connection to the Textweiser database. They can either be given on the commandline and/or be supplied in a configuration file (-f / --config).

NOTE: If Textweiser uses an SQLite database backend, only the -d / --db_name option is required and all other database options are not available.

-d / --db_name database name

Name of the Textweiser database (UTF-8 encoded).

If Textweiser uses an SQLite database backend, database name is the path to the database file, not necessarily UTF-8 encoded.

-s / --host hostname

Hostname of the database server.

-u / --user username

Username to connect to the database.

-w / --passwd password

Password to connect to the database.

NOTE: If no password is given as an argument on the commandline and no password is set in the configuration file, you will be prompted to enter the password. The password will not be echoed during input.

-p / --port port

Port of the database on hostname.

If port is not set, the default port of the database is assumed.

-t / --instance instance

Name of the Microsoft SQL Server instance on hostname.

NOTE: This option is only available if Textweiser uses the Microsoft SQL Server database backend.

-e / --encrypt

Request communication to the database to be encrypted. If no encrypted connection can be established by the database driver, Textweiser will abort.

--trust-cert

Request to trust any certificate presented by the database server, without validation.

NOTE: In order to use self-signed certificates, this option has to be enabled.

NOTE: Passing this option implicitly enables communication encryption.

The database configuration may be given in a configuration file as well. For details, see CONFIGURATION FILE SYNTAX below.

-f / --config path

Path to a Textweiser database configuration file.

-v / --verbose

Enable verbose output.

-V / --version

Show version information and terminate.

-h / --help

Show a short help screen and terminate.

The -B / --backup option enables tw-backup's backup mode.

-o / --output PATH

Path to the backup file that should be used to store all data of the Textweiser database.

The -R / --restore option enables tw-backup's restore mode.

-i / --input PATH

Path to a previously created backup file that should be used to restore all data to the Textweiser database.

If an error occurs, the application terminates with an appropriate error code dependent on the operating system in use and prints an error message to stderr.

The syntax of Textweiser configuration files follows an easy to use key/value scheme. Empty lines and any leading/trailing whitespace is ignored. Lines starting with the character # are considered comments.

Values may be enclosed within matching single or double quotes and are assigned to keys using the = character.

host

Hostname of the database server.

user

Username for database authentification.

passwd

Password for database authentification.

db_name

Name of the Textweiser database.

port

Port number of the database server.

instance

Name of the Microsoft SQL Server instance.

encrypt

Enable/disable communication encryption.

The following values are recognized:

"yes" or "on"

Enable encryption.

"no" or "off"

Disable encryption.

In order to trust a server's certificate, append the "trust-cert" token to the value, separated by a comma and/or whitespace, i.e.

 encrypt = "yes, trust-cert"

o

When restoring a Textweiser database, any data currently stored in the Textweiser database is removed and replaced by the backup's data.

o

It is recommended to regularly backup your Textweiser databases.

o

On any Unix-like system the common sequence "--" terminates parsing of options.

o

Any configuration file specified (-f / --config) is parsed and evaluated before other commandline arguments are evaluated. As a result, arguments given on the commandline overwrite settings given in a configuration file.

o

Communication encryption is the task of the database driver. Textweiser merely instructs the driver to enable or disable encryption according to the passed options and checks whether the operation did succeed.

For brevity, the following examples assume Textweiser is using the SQLite database backend and that a Textweiser database and a set of categories have already been created and trained. See the EXAMPLES section of tw-admin(1) and tw-learn(1) for details.

List all categories and create a Textweiser database backup:

Shell $ tw-admin -v -d example.sqlt -L
 Categories in example.sqlt:
 01: IT
 02: IT::Projects
 03: IT::Sales
 04: Marketing
 $ tw-backup -v -d example.sqlt -B -o example.bup
 Storing backup of example.sqlt to example.bup

Restore the generated backup and list all categories again:

Shell $ tw-backup -v -d example.sqlt -R -i example.bup
 Restoring backup from example.bup to example.sqlt
 $ tw-admin -v -d example.sqlt -L
 Categories in example.sqlt:
 01: IT
 02: IT::Projects
 03: IT::Sales
 04: Marketing

tw-admin(1), tw-learn(1)

Textweiser User Manual

http://www.lingua-systems.com/text-classifier/textweiser-library/

Copyright (c) 2010-2011 Lingua-Systems Software GmbH