Subversion Repositories pub

Compare Revisions

Ignore whitespace Rev 132 → Rev 135

/relevation/branches/0.3/manpage.sgml
12,18 → 12,16
docbook-to-man $< > $@
-->
 
<!-- Fill in your name for FIRSTNAME and SURNAME. -->
<!ENTITY dhfirstname "<firstname>Toni</firstname>">
<!ENTITY dhsurname "<surname>Corvera</surname>">
<!-- Please adjust the date whenever revising the manpage. -->
<!ENTITY dhdate "<date>June 27, 2011</date>">
<!-- SECTION should be 1-8, maybe w/ subsection other parameters are
allowed: see man(7), man(1). -->
<!ENTITY dhsection "<manvolnum>1</manvolnum>">
<!ENTITY dhemail "<email>outlyer@gmail.com</email>">
<!ENTITY dhusername "Toni Corvera">
<!ENTITY dhucpackage "<refentrytitle>RELEVATION</refentrytitle>">
<!ENTITY dhpackage "relevation">
<!ENTITY gnu "<acronym>GNU</acronym>">
]>
 
<refentry>
36,7 → 34,7
&dhsurname;
</author>
<copyright>
<year>2003</year>
<year>2011</year>
<holder>&dhusername;</holder>
</copyright>
&dhdate;
53,37 → 51,37
</refnamediv>
<refsynopsisdiv>
<cmdsynopsis>
<command>&dhpackage;</command>
</cmdsynopsis>
<cmdsynopsis>
<command>&dhpackage;</command>
<option> -f <replaceable>/path/to/file.</replaceable></option>
<group><option> -f <replaceable>/path/to/file.</replaceable></option></group>
 
<option> -p <replaceable>password</replaceable></option>
<group><option> -p <replaceable>password</replaceable></option></group>
 
<arg><option>search string</option></arg>
<arg><option><replaceable>search string</replaceable></option></arg>
</cmdsynopsis>
<cmdsynopsis>
<command>&dhpackage;</command>
<arg><option><replaceable>search string</replaceable></option></arg>
</cmdsynopsis>
</refsynopsisdiv>
<refsect1>
<title>DESCRIPTION</title>
 
<para>Access and print or search passwords in a <application>Revelation</application> password
file.</para>
<para>Access and print or search passwords in a <application>Revelation</application> password file.</para>
 
<para>Only read access is provided, to edit the files <application>Revelation</application>
must be used.</para>
<para>Only read access is provided, to edit the files <application>Revelation</application> must be used.</para>
 
<para>With a search string, only entries that match the search string in any
of its fields will be printed.</para>
<para>With a search string, only entries that match the search string in any of its fields will be printed.</para>
 
<para>When no search string is provided the whole, unencrypted, XML file will be
printed.</para>
<para>When no search string is provided the whole, unencrypted, XML file will be printed.</para>
 
</refsect1>
<refsect1>
<title>OPTIONS</title>
 
<para>This program follows the usual &gnu; command line syntax,
with long options starting with two dashes (`-'). A summary of
options is included below. For a complete description, see the
<application>Info</application> files.</para>
<para>This program follows the usual &gnu; command line syntax, with long options starting with two dashes (`-'). A summary of options is included below.</para>
 
<variablelist>
<varlistentry>
90,11 → 88,10
<term><option>-f <replaceable>file.revelation</replaceable></option>, <option>--file=<replaceable>file.revelation</replaceable></option>
</term>
<listitem>
<para>File name of the <command>revelation</command> file (the file
containing the list of stored credentials).</para>
<para>File name of the <command>revelation</command> file (the file containing the list of stored credentials).</para>
</listitem>
</varlistentry>
<varlistentry>
<varlistentry>
<term><option>-p <replaceable>password</replaceable></option>, <option>--password=<replaceable>password</replaceable></option>
</term>
<listitem>
102,7 → 99,7
</listitem>
</varlistentry>
<varlistentry>
<term><option>-a</option>, <option>--ask, <option>-0</option>, <option>--stdin</option></option>
<term><option>-a</option>, <option>--ask</option>, <option>-0</option>, <option>--stdin</option>
</term>
<listitem>
<para>Ask interactively for password.</para>
116,8 → 113,7
<listitem>
<para>When searching for text, disregard case.</para>
<para>This is the default behaviour.</para>
<para>If the search string contains special/non-English characters this is
likely to fail.</para>
<para>If the search string contains special/non-English characters this is likely to fail.</para>
</listitem>
</varlistentry>
<varlistentry>
152,6 → 148,17
</variablelist>
</refsect1>
<refsect1>
<title>CONFIGURATION FILE</title>
 
<para>A configuration file `.relevation.conf' located at the user's home directory can be used to avoid having to provide the filename and/or password on each run.</para>
<para>Example `~/.relevation.conf':</para>
<programlisting>&nbsp;[relevation]
&nbsp;file=~/passwords.revelation
&nbsp;password=my secret password</programlisting>
<para>Both file and password are optional, so you can store the filename without storing the password.</para>
<para>Please understand your password is stored in this file in clear text, modify the file permissions appropriately so that only your user can read it, otherwise your master password might be compromised and hence all your stored password will be too.</para>
</refsect1>
<refsect1>
<title>SEE ALSO</title>
 
<para>revelation (1)</para>
159,27 → 166,9
<refsect1>
<title>AUTHOR</title>
 
<para>This manual page was written by &dhusername; &dhemail;.
Permission is
granted to copy, distribute and/or modify this document under
the terms of a BSD 3-clause license.
<para>This manual page was written by &dhusername; &lt;&dhemail;&gt;.
Permission is granted to copy, distribute and/or modify this document under the terms of a BSD 3-clause license.
</para>
</refsect1>
</refentry>
 
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:2
sgml-indent-data:t
sgml-parent-document:nil
sgml-default-dtd-file:nil
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
-->
<!-- vim: set et: -->