docs-xml/manpages/smbta-util.8.xml

   1 <?xml version="1.0" encoding="iso-8859-1"?>
   2 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
   3 <refentry id="smbta-util.8">
   4
   5 <refmeta>
   6         <refentrytitle>smbta-util</refentrytitle>
   7         <manvolnum>8</manvolnum>
   8         <refmiscinfo class="source">Samba</refmiscinfo>
   9         <refmiscinfo class="manual">System Administration tools</refmiscinfo>
  10         <refmiscinfo class="version">4.1</refmiscinfo>
  11 </refmeta>
  12
  13
  14 <refnamediv>
  15         <refname>smbta-util</refname>
  16         <refpurpose>control encryption in VFS smb_traffic_analyzer</refpurpose>
  17 </refnamediv>
  18
  19 <refsynopsisdiv>
  20
  21         <cmdsynopsis>
  22                 <command>smbta-util</command>
  23                 <arg rep="repeat" choice="opt">
  24                 <replaceable>COMMANDS</replaceable>
  25                 </arg>
  26         </cmdsynopsis>
  27
  28 </refsynopsisdiv>
  29
  30 <refsect1>
  31         <title>DESCRIPTION</title>
  32
  33         <para>This tool is part of the
  34         <citerefentry><refentrytitle>samba</refentrytitle>
  35         <manvolnum>1</manvolnum></citerefentry> suite.</para>
  36
  37         <para><command>smbta-util</command> is a tool to ease the
  38         configuration of the vfs_smb_traffic_analyzer module regarding
  39         data encryption.</para>
  40         <para>The user can generate a key, install a key (activating
  41         encryption), or uninstall a key (deactivating encryption).
  42         Any operation that installs a key will create a File containing
  43         the key. This file can be used by smbta-tool on other machines
  44         to install the same key from the file.</para>
  45
  46
  47 </refsect1>
  48
  49
  50 <refsect1>
  51         <title>COMMANDS</title>
  52
  53         <variablelist>
  54
  55                 <varlistentry>
  56                 <term><option>-h</option></term>
  57                 <listitem><para>Show a short help text on the command line.
  58                 </para></listitem>
  59                 </varlistentry>
  60
  61                 <varlistentry>
  62                 <term><option>-f</option>
  63                 <replaceable>KEYFILE</replaceable></term>
  64                 <listitem><para>Open an existing keyfile, read the key from
  65                 the file, and install the key, activating encryption.
  66                 </para></listitem>
  67                 </varlistentry>
  68
  69                 <varlistentry>
  70                 <term><option>-g</option>
  71                 <replaceable>KEYFILE</replaceable></term>
  72                 <listitem><para>Generate a new random key, install the key,
  73                 activate encryption, and store the key into the file KEYFILE.
  74                 </para></listitem>
  75                 </varlistentry>
  76
  77                 <varlistentry>
  78                 <term><option>-u</option></term>
  79                 <listitem><para>Uninstall the key, deactivating encryption.
  80                 </para></listitem>
  81                 </varlistentry>
  82
  83                 <varlistentry>
  84                 <term><option>-s</option></term>
  85                 <listitem><para>Check if a key is installed.
  86                 </para></listitem>
  87                 </varlistentry>
  88
  89                 <varlistentry>
  90                 <term><option>-c</option>
  91                 <replaceable>KEYFILE</replaceable></term>
  92                 <listitem><para>Create a KEYFILE from an installed key.
  93                 </para></listitem>
  94                 </varlistentry>
  95
  96
  97         </variablelist>
  98 </refsect1>
  99
 100 <refsect1>
 101         <title>VERSION</title>
 102         <para>This man page is correct for version 3.4 of the Samba suite.</para>
 103 </refsect1>
 104
 105 <refsect1>
 106         <title>AUTHOR</title>
 107         <para> The original version of smbta-util was created by Holger Hetterich.
 108         </para>
 109         <para> The original Samba software and related utilities were
 110         created by Andrew Tridgell.  Samba is now developed by the
 111         Samba Team as an Open Source project similar to the way the
 112         Linux kernel is developed.</para>
 113 </refsect1>
 114
 115 </refentry>