diff options
Diffstat (limited to 'docs-xml/manpages-3/smbta-util.8.xml')
-rw-r--r-- | docs-xml/manpages-3/smbta-util.8.xml | 119 |
1 files changed, 119 insertions, 0 deletions
diff --git a/docs-xml/manpages-3/smbta-util.8.xml b/docs-xml/manpages-3/smbta-util.8.xml new file mode 100644 index 0000000000..094fb9d833 --- /dev/null +++ b/docs-xml/manpages-3/smbta-util.8.xml @@ -0,0 +1,119 @@ +<?xml version="1.0" encoding="iso-8859-1"?> +<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> +<refentry id="smbta-tool.8"> + +<refmeta> + <refentrytitle>smbta-tool</refentrytitle> + <manvolnum>8</manvolnum> + <refmiscinfo class="source">Samba</refmiscinfo> + <refmiscinfo class="manual">System Administration tools</refmiscinfo> + <refmiscinfo class="version">3.6</refmiscinfo> +</refmeta> + + +<refnamediv> + <refname>smbta-tool</refname> + <refpurpose>control encryption in VFS smb_traffic_analyzer</refpurpose> +</refnamediv> + +<refsynopsisdiv> + + <cmdsynopsis> + <command>smbta-tool</command> + </cmdsynopsis> + + <cmdsynopsis> + <command>smbta-tool</command> + <arg rep="repeat" choice="opt"> + <replaceable>COMMANDS</replaceable> + </arg> + </cmdsynopsis> + +</refsynopsisdiv> + +<refsect1> + <title>DESCRIPTION</title> + + <para>This tool is part of the + <citerefentry><refentrytitle>samba</refentrytitle> + <manvolnum>1</manvolnum></citerefentry> suite.</para> + + <para><command>smbta-tool</command> is a tool to ease the + configuration of the vfs_smb_traffic_analyzer module regarding + data encryption.</para> + <para>The user can generate a key, install a key (activating + encryption), or uninstall a key (deactivating encryption). + Any operation that installs a key will create a File containing + the key. This file can be used by smbta-tool on other machines + to install the same key from the file.</para> + + +</refsect1> + + +<refsect1> + <title>COMMANDS</title> + + <variablelist> + + <varlistentry> + <term><option>-h</option></term> + <listitem><para>Show a short help text on the command line. + </para></listitem> + </varlistentry> + + <varlistentry> + <term><option>-f</option> + <replaceable>KEYFILE</replaceable></term> + <listitem><para>Open an existing keyfile, read the key from + the file, and install the key, activating encryption. + </para></listitem> + </varlistentry> + + <varlistentry> + <term><option>-g</option> + <replaceable>KEYFILE</replaceable></term> + <listitem><para>Generate a new random key, install the key, + activate encryption, and store the key into the file KEYFILE. + </para></listitem> + </varlistentry> + + <varlistentry> + <term><option>-u</option></term> + <listitem><para>Uninstall the key, deactivating encryption. + </para></listitem> + </varlistentry> + + <varlistentry> + <term><option>-s</option></term> + <listitem><para>Check if a key is installed. + </para></listitem> + </varlistentry> + + <varlistentry> + <term><option>-c</option> + <replaceable>KEYFILE</replaceable></term> + <listitem><para>Create a KEYFILE from an installed key. + </para></listitem> + </varlistentry> + + + </variablelist> +</refsect1> + +<refsect1> + <title>VERSION</title> + <para>This man page is correct for version 3.4 of the Samba suite.</para> +</refsect1> + +<refsect1> + <title>AUTHOR</title> + <para> The original version of smbta-util was created by Holger Hetterich. + </para> + <para> The original Samba software and related utilities were + created by Andrew Tridgell. Samba is now developed by the + Samba Team as an Open Source project similar to the way the + Linux kernel is developed.</para> +</refsect1> + +</refentry> |