summaryrefslogtreecommitdiff
path: root/docs-xml/manpages/smbta-util.8.xml
diff options
context:
space:
mode:
authorKarolin Seeger <kseeger@samba.org>2012-09-03 21:49:25 +0200
committerKarolin Seeger <kseeger@samba.org>2012-09-03 23:35:37 +0200
commit75484f491140fb86eaee90dde1dc1c9d4ebe8a41 (patch)
tree08c03686f244d1c9417b17577a112e3fa36397aa /docs-xml/manpages/smbta-util.8.xml
parent9c44e2e5392926773c9966e8bda924d1e6c9b591 (diff)
downloadsamba-75484f491140fb86eaee90dde1dc1c9d4ebe8a41.tar.gz
samba-75484f491140fb86eaee90dde1dc1c9d4ebe8a41.tar.bz2
samba-75484f491140fb86eaee90dde1dc1c9d4ebe8a41.zip
docs: Rename manpages-3 -> manpages.
This change was suggested by Andrew Bartlett on the samba-technical mailing list. Karolin Autobuild-User(master): Karolin Seeger <kseeger@samba.org> Autobuild-Date(master): Mon Sep 3 23:35:38 CEST 2012 on sn-devel-104
Diffstat (limited to 'docs-xml/manpages/smbta-util.8.xml')
-rw-r--r--docs-xml/manpages/smbta-util.8.xml119
1 files changed, 119 insertions, 0 deletions
diff --git a/docs-xml/manpages/smbta-util.8.xml b/docs-xml/manpages/smbta-util.8.xml
new file mode 100644
index 0000000000..6e53aaab0a
--- /dev/null
+++ b/docs-xml/manpages/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-util.8">
+
+<refmeta>
+ <refentrytitle>smbta-util</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-util</refname>
+ <refpurpose>control encryption in VFS smb_traffic_analyzer</refpurpose>
+</refnamediv>
+
+<refsynopsisdiv>
+
+ <cmdsynopsis>
+ <command>smbta-util</command>
+ </cmdsynopsis>
+
+ <cmdsynopsis>
+ <command>smbta-util</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-util</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>