12,16 → 12,18 |
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 28, 2011</date>"> |
<!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> |
34,7 → 36,7 |
&dhsurname; |
</author> |
<copyright> |
<year>2011</year> |
<year>2003</year> |
<holder>&dhusername;</holder> |
</copyright> |
&dhdate; |
51,27 → 53,37 |
</refnamediv> |
<refsynopsisdiv> |
<cmdsynopsis> |
<command>&dhpackage;</command> |
<arg choice="opt"><option>options</option></arg> |
<arg choice="opt"><replaceable>search string</replaceable> <arg choice="opt"><replaceable>...</replaceable></arg></arg> |
<command>&dhpackage;</command> |
<option> -f <replaceable>/path/to/file.</replaceable></option> |
|
<option> -p <replaceable>password</replaceable></option> |
|
<arg><option>search string</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 list of entries 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.</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. For a complete description, see the |
<application>Info</application> files.</para> |
|
<variablelist> |
<varlistentry> |
78,10 → 90,11 |
<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> |
89,7 → 102,7 |
</listitem> |
</varlistentry> |
<varlistentry> |
<term><option>-a</option>, <option>--ask</option>, <option>-0</option>, <option>--stdin</option> |
<term><option>-a</option>, <option>--ask, <option>-0</option>, <option>--stdin</option></option> |
</term> |
<listitem> |
<para>Ask interactively for password.</para> |
98,21 → 111,13 |
</listitem> |
</varlistentry> |
<varlistentry> |
<term><option>-t <replaceable>type</replaceable></option>, <option>--type=<replaceable>type</replaceable></option></term> |
<listitem> |
<para>Print only entries of a certain type.</para> |
<para>Known types: creditcard, cryptokey, database, door, email, folder, ftp, generic, phone, shell, website.</para> |
<para>If preceded by a slash it will be negated, i.e. `-website' will select entries that are not of type website.</para> |
<para>When searching for a string, folders are skipped (equivalent to `--type=-folder').</para> |
</listitem> |
</varlistentry> |
<varlistentry> |
<term><option>-i</option>, <option>--case-insensitive</option> |
</term> |
<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> |
141,23 → 146,12 |
<term><option>--version</option> |
</term> |
<listitem> |
<para>Show version information for &dhpackage;.</para> |
<para>Show version of program.</para> |
</listitem> |
</varlistentry> |
</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> [relevation] |
file=~/passwords.revelation |
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> |
165,9 → 159,27 |
<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 2-clause license. |
<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> |
</refsect1> |
</refentry> |
<!-- vim: set et: --> |
|
<!-- 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: |
--> |