| 0,0 → 1,173 |
|---|
| <!doctype refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN" [ |
| |
| <!-- |
| This file is derived from Debian's template for added manpages. |
| |
| Process this file with docbook-to-man to generate an nroff manual |
| page: `docbook-to-man manpage.sgml > manpage.1'. You may view |
| the manual page with: `docbook-to-man manpage.sgml | nroff -man | |
| less'. A typical entry in a Makefile or Makefile.am is: |
| |
| manpage.1: manpage.sgml |
| docbook-to-man $< > $@ |
| --> |
| |
| <!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 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> |
| <refentryinfo> |
| <address> |
| &dhemail; |
| </address> |
| <author> |
| &dhfirstname; |
| &dhsurname; |
| </author> |
| <copyright> |
| <year>2011</year> |
| <holder>&dhusername;</holder> |
| </copyright> |
| &dhdate; |
| </refentryinfo> |
| <refmeta> |
| &dhucpackage; |
| |
| &dhsection; |
| </refmeta> |
| <refnamediv> |
| <refname>&dhpackage;</refname> |
| |
| <refpurpose>command-line searcher for <application>Revelation</application> files</refpurpose> |
| </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> |
| </cmdsynopsis> |
| </refsynopsisdiv> |
| <refsect1> |
| <title>DESCRIPTION</title> |
| |
| <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>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> |
| |
| </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> |
| |
| <variablelist> |
| <varlistentry> |
| <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> |
| </listitem> |
| </varlistentry> |
| <varlistentry> |
| <term><option>-p <replaceable>password</replaceable></option>, <option>--password=<replaceable>password</replaceable></option> |
| </term> |
| <listitem> |
| <para>Decryption password.</para> |
| </listitem> |
| </varlistentry> |
| <varlistentry> |
| <term><option>-a</option>, <option>--ask</option>, <option>-0</option>, <option>--stdin</option> |
| </term> |
| <listitem> |
| <para>Ask interactively for password.</para> |
| <para>When <option>-a</option> or <option>--ask</option> is used a prompt will be printed.</para> |
| <para>Use either one of this variants or <option>--password</option>.</para> |
| </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> |
| </listitem> |
| </varlistentry> |
| <varlistentry> |
| <term><option>-c</option>, <option>--case-sensitive</option> |
| </term> |
| <listitem> |
| <para>When searching for text, obey case.</para> |
| </listitem> |
| </varlistentry> |
| <varlistentry> |
| <term><option>-s <replaceable>search string</replaceable></option>, <option>--search=<replaceable>search string</replaceable></option>, <option><replaceable>search string</replaceable></option> |
| </term> |
| <listitem> |
| <para>Search the file for a pice of text. All fields will be searched.</para> |
| </listitem> |
| </varlistentry> |
| |
| <varlistentry> |
| <term><option>-h</option>, <option>--help</option> |
| </term> |
| <listitem> |
| <para>Show summary of options.</para> |
| </listitem> |
| </varlistentry> |
| <varlistentry> |
| <term><option>--version</option> |
| </term> |
| <listitem> |
| <para>Show version information for &dhpackage;.</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> |
| </refsect1> |
| <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> |
| </refsect1> |
| </refentry> |
| <!-- vim: set et: --> |