Subversion Repositories pub

Compare Revisions

Ignore whitespace Rev 123 → Rev 124

/relevation/branches/0.2/manpage.sgml
0,0 → 1,185
<!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 $< > $@
-->
 
<!-- 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">
]>
 
<refentry>
<refentryinfo>
<address>
&dhemail;
</address>
<author>
&dhfirstname;
&dhsurname;
</author>
<copyright>
<year>2003</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>
<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>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, 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>
 
<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>-0</option>, <option>--stdin</option></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>-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 of program.</para>
</listitem>
</varlistentry>
</variablelist>
</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 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:
-->