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.0</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         </cmdsynopsis>
  24
  25         <cmdsynopsis>
  26                 <command>smbta-util</command>
  27                 <arg rep="repeat" choice="opt">
  28                 <replaceable>COMMANDS</replaceable>
  29                 </arg>
  30         </cmdsynopsis>
  31
  32 </refsynopsisdiv>
  33
  34 <refsect1>
  35         <title>DESCRIPTION</title>
  36
  37         <para>This tool is part of the
  38         <citerefentry><refentrytitle>samba</refentrytitle>
  39         <manvolnum>1</manvolnum></citerefentry> suite.</para>
  40
  41         <para><command>smbta-util</command> is a tool to ease the
  42         configuration of the vfs_smb_traffic_analyzer module regarding
  43         data encryption.</para>
  44         <para>The user can generate a key, install a key (activating
  45         encryption), or uninstall a key (deactivating encryption).
  46         Any operation that installs a key will create a File containing
  47         the key. This file can be used by smbta-tool on other machines
  48         to install the same key from the file.</para>
  49
  50
  51 </refsect1>
  52
  53
  54 <refsect1>
  55         <title>COMMANDS</title>
  56
  57         <variablelist>
  58
  59                 <varlistentry>
  60                 <term><option>-h</option></term>
  61                 <listitem><para>Show a short help text on the command line.
  62                 </para></listitem>
  63                 </varlistentry>
  64
  65                 <varlistentry>
  66                 <term><option>-f</option>
  67                 <replaceable>KEYFILE</replaceable></term>
  68                 <listitem><para>Open an existing keyfile, read the key from
  69                 the file, and install the key, activating encryption.
  70                 </para></listitem>
  71                 </varlistentry>
  72
  73                 <varlistentry>
  74                 <term><option>-g</option>
  75                 <replaceable>KEYFILE</replaceable></term>
  76                 <listitem><para>Generate a new random key, install the key,
  77                 activate encryption, and store the key into the file KEYFILE.
  78                 </para></listitem>
  79                 </varlistentry>
  80
  81                 <varlistentry>
  82                 <term><option>-u</option></term>
  83                 <listitem><para>Uninstall the key, deactivating encryption.
  84                 </para></listitem>
  85                 </varlistentry>
  86
  87                 <varlistentry>
  88                 <term><option>-s</option></term>
  89                 <listitem><para>Check if a key is installed.
  90                 </para></listitem>
  91                 </varlistentry>
  92
  93                 <varlistentry>
  94                 <term><option>-c</option>
  95                 <replaceable>KEYFILE</replaceable></term>
  96                 <listitem><para>Create a KEYFILE from an installed key.
  97                 </para></listitem>
  98                 </varlistentry>
  99
 100
 101         </variablelist>
 102 </refsect1>
 103
 104 <refsect1>
 105         <title>VERSION</title>
 106         <para>This man page is correct for version 3.4 of the Samba suite.</para>
 107 </refsect1>
 108
 109 <refsect1>
 110         <title>AUTHOR</title>
 111         <para> The original version of smbta-util was created by Holger Hetterich.
 112         </para>
 113         <para> The original Samba software and related utilities were
 114         created by Andrew Tridgell.  Samba is now developed by the
 115         Samba Team as an Open Source project similar to the way the
 116         Linux kernel is developed.</para>
 117 </refsect1>
 118
 119 </refentry>