write manpage0.8.3

3 files changed, 60 insertions, 350 deletions

diff --git a/docs/pwgrep.1 b/docs/pwgrep.1
index cf5ac93..ef76828 100644
--- a/docs/pwgrep.1
+++ b/docs/pwgrep.1
@@ -130,136 +130,26 @@
 .if n .ad l
 .nh
 .SH "NAME"
-pwgrep \- A template project
-.SH "WTF?"
-.IX Header "WTF?"
-You may use this project in order to build your own Debian package for your own project. This has been tested with Debian GNU/Linux Squeeze and Debian GNU/Linux Wheezy.
-.PP
-Feel free to modify any aspects. This project is just an empty example pwgrep.
-.PP
-Follow these steps:
-.SS "Install required packages"
-.IX Subsection "Install required packages"
-Run the following:
-.PP
-.Vb 1
-\&    sudo aptitude install lintian devscripts dpkg\-dev make perl
-.Ve
-.PP
-Todo: Ensure this are the correct packages. In order to test that I would have to setup a blank Debian system.
-.SS "Compile the project"
-.IX Subsection "Compile the project"
-Go to the to level directory and run
-.PP
-.Vb 1
-\&    make
-.Ve
-.PP
-To test run
-.PP
-.Vb 1
-\&    ./bin/pwgrep
-.Ve
-.PP
-It should print out the version number of the project.
-.SS "Create a Debian package"
-.IX Subsection "Create a Debian package"
-Go to the to level directory and run
-.PP
-.Vb 1
-\&    make deb
-.Ve
-.PP
-It will create the files like:
-.PP
-.Vb 4
-\&    ../pwgrep_0.0.0.0_all.deb
-\&    ../pwgrep_0.0.0.0.dsc
-\&    ../pwgrep_0.0.0.0_amd64.changes
-\&    ../pwgrep_0.0.0.0.tar.gz
-.Ve
-.PP
-It should create a debian package in ../. Check and install it, e.g:
-.PP
-.Vb 2
-\&    lintian \-\-pedantic ../pwgrep_0.0.0.0_all.deb 
-\&    sudo dpkg \-i ../pwgrep_0.0.0.0_all.deb
-.Ve
-.PP
-Run
-.PP
-.Vb 1
-\&    dpkg \-L pwgrep
-.Ve
-.PP
-to see whats in there. You can now run
-.PP
-.Vb 1
-\&    /usr/bin/pwgrep
-.Ve
-.PP
-or for example
-.PP
-.Vb 1
-\&    man pwgrep
-.Ve
-.SS "Read the Makefile"
-.IX Subsection "Read the Makefile"
-Read the Makefile in order to understand what's going on.
-.SH "Customize"
-.IX Header "Customize"
-Now, since you understood everything feel free to customize everything the way you want it. E.g.:
-.PP
-.Vb 1
-\&    Don\*(Aqt use POD for documentation but LaTeX
-\&
-\&    Compile a C program
-\&
-\&    Include a ./lib dir, add it to the \*(Aqinstall\*(Aq Makefile rule
-\&
-\&    etc etc.
-.Ve
-.PP
-You should also consider the following:
-.SS "Manual page"
-.IX Subsection "Manual page"
-This template is using \s-1POD\s0 for creating manual pages. Edit ./docs/pwgrep.pod and run
-.PP
-.Vb 1
-\&    make documentation
-.Ve
-.PP
-in order to build ./docs/pwgrep.1. The page will be included in the resulting debian package automatically. You can review the page with
-.PP
-.Vb 1
-\&    man ./docs/pwgrep.1
-.Ve
-.SS "Renaming pwgrep into your project name"
-.IX Subsection "Renaming pwgrep into your project name"
-Rename all files which have *pwgrep* included into your own new package name. You can find them with
-.PP
-.Vb 1
-\&    find . \-name \e*pwgrep\e*
-.Ve
-.PP
-Search all content and rename *pwgrep* into your own new package name. You can find all files with
-.PP
-.Vb 1
-\&    grep \-R pwgrep . | grep \-v .git
-.Ve
-.SS "Updating ./debian"
-.IX Subsection "Updating ./debian"
-Edit the following files accordingly to your new project (e.g. with vim):
-.PP
-.Vb 3
-\&    ./debian/control
-\&    ./debian/copyright
-\&    ./debian/README
-.Ve
-.SS "Update changelog"
-.IX Subsection "Update changelog"
-Go to the to level directory and run
-.PP
-.Vb 1
-\&    dch \-i
-.Ve
+pwgrep \- Managing passwords...
+.SH "Synopsis"
+.IX Header "Synopsis"
+.Vb 10
+\&  fwipe <FILE>            \- Wiping a file
+\&  pwdbls                  \- Listing available DBs
+\&  pwedit [OPTS]           \- Editing current DB
+\&  pwfadd <FILE>           \- Adding a file to FDB
+\&  pwfcat <NAME>           \- Printing a file from filestore to stdout
+\&  pwfdel <NAME>           \- Deleting a file from filestore
+\&  pwgrep [OPTS] <REGEX>   \- Grepping current DB
+\&  pwldb                   \- Synonym for pwdbls
+\&  pwupdate                \- Updating FDB and all DBs
+\&  pwhelp                  \- Printing this help screen
+.Ve
+.PP
+Where \s-1OPTS\s0 are:
+  \-o                      \- Offline mode
+  \-d <\s-1DB\s0 \s-1NAME\s0>            \- Using a specific \s-1DB\s0
+  \-a                 \- Searching all available DBs or categories at once
+.SH "Tutorial"
+.IX Header "Tutorial"
+Please go to <http://pwgrep.buetow.org> .
diff --git a/docs/pwgrep.pod b/docs/pwgrep.pod
index 72c34fa..96156fd 100644
--- a/docs/pwgrep.pod
+++ b/docs/pwgrep.pod
@@ -1,113 +1,25 @@
 =head1 NAME
 
-pwgrep - A template project
+pwgrep - Managing passwords...
 
-=head1 WTF?
+=head1 Synopsis
 
-You may use this project in order to build your own Debian package for your own project. This has been tested with Debian GNU/Linux Squeeze and Debian GNU/Linux Wheezy. 
+  fwipe <FILE>            - Wiping a file
+  pwdbls                  - Listing available DBs
+  pwedit [OPTS]           - Editing current DB
+  pwfadd <FILE>           - Adding a file to FDB
+  pwfcat <NAME>           - Printing a file from filestore to stdout
+  pwfdel <NAME>           - Deleting a file from filestore
+  pwgrep [OPTS] <REGEX>   - Grepping current DB
+  pwldb                   - Synonym of pwdbls
+  pwupdate                - Updating FDB and all DBs
+  pwhelp                  - Printing this help screen
 
-Feel free to modify any aspects. This project is just an empty example pwgrep.
+Where OPTS are:
+  -o                      - Offline mode
+  -d <DB NAME>            - Using a specific DB
+  -a                 - Searching all available DBs or categories at once
 
-Follow these steps:
+=head1 Tutorial
 
-=head2 Install required packages
-
-Run the following:
-
-    sudo aptitude install lintian devscripts dpkg-dev make perl
-
-Todo: Ensure this are the correct packages. In order to test that I would have to setup a blank Debian system.
-
-=head2 Compile the project
-
-Go to the to level directory and run
-
-    make
-
-To test run
-
-    ./bin/pwgrep
-
-It should print out the version number of the project.
-
-=head2 Create a Debian package
-
-Go to the to level directory and run
-
-    make deb
-
-It will create the files like:
-
-    ../pwgrep_0.0.0.0_all.deb
-    ../pwgrep_0.0.0.0.dsc
-    ../pwgrep_0.0.0.0_amd64.changes
-    ../pwgrep_0.0.0.0.tar.gz
-
-It should create a debian package in ../. Check and install it, e.g:
-
-    lintian --pedantic ../pwgrep_0.0.0.0_all.deb 
-    sudo dpkg -i ../pwgrep_0.0.0.0_all.deb 
-
-Run 
-
-    dpkg -L pwgrep
-
-to see whats in there. You can now run
-
-    /usr/bin/pwgrep
-
-or for example
-
-    man pwgrep
-
-=head2 Read the Makefile
-
-Read the Makefile in order to understand what's going on.
-
-=head1 Customize
-
-Now, since you understood everything feel free to customize everything the way you want it. E.g.: 
-
-    Don't use POD for documentation but LaTeX
-
-    Compile a C program
-
-    Include a ./lib dir, add it to the 'install' Makefile rule
-
-    etc etc.
-
-You should also consider the following:
-
-=head2 Manual page
-
-This template is using POD for creating manual pages. Edit ./docs/pwgrep.pod and run 
-
-    make documentation
-
-in order to build ./docs/pwgrep.1. The page will be included in the resulting debian package automatically. You can review the page with
-
-    man ./docs/pwgrep.1
-
-=head2 Renaming pwgrep into your project name 
-
-Rename all files which have *pwgrep* included into your own new package name. You can find them with
-
-    find . -name \*pwgrep\*
-
-Search all content and rename *pwgrep* into your own new package name. You can find all files with
-
-    grep -R pwgrep . | grep -v .git
-
-=head2 Updating ./debian
-
-Edit the following files accordingly to your new project (e.g. with vim):
-
-    ./debian/control
-    ./debian/copyright
-    ./debian/README
-
-=head2 Update changelog
-
-Go to the to level directory and run
-
-    dch -i
+Please go to L<http://pwgrep.buetow.org> .
diff --git a/docs/pwgrep.txt b/docs/pwgrep.txt
index 3ac1efb..ef1fd19 100644
--- a/docs/pwgrep.txt
+++ b/docs/pwgrep.txt
@@ -1,113 +1,21 @@
 NAME
-    pwgrep - A template project
-
-WTF?
-    You may use this project in order to build your own Debian package for
-    your own project. This has been tested with Debian GNU/Linux Squeeze and
-    Debian GNU/Linux Wheezy.
-
-    Feel free to modify any aspects. This project is just an empty example
-    pwgrep.
-
-    Follow these steps:
-
-  Install required packages
-    Run the following:
-
-        sudo aptitude install lintian devscripts dpkg-dev make perl
-
-    Todo: Ensure this are the correct packages. In order to test that I
-    would have to setup a blank Debian system.
-
-  Compile the project
-    Go to the to level directory and run
-
-        make
-
-    To test run
-
-        ./bin/pwgrep
-
-    It should print out the version number of the project.
-
-  Create a Debian package
-    Go to the to level directory and run
-
-        make deb
-
-    It will create the files like:
-
-        ../pwgrep_0.0.0.0_all.deb
-        ../pwgrep_0.0.0.0.dsc
-        ../pwgrep_0.0.0.0_amd64.changes
-        ../pwgrep_0.0.0.0.tar.gz
-
-    It should create a debian package in ../. Check and install it, e.g:
-
-        lintian --pedantic ../pwgrep_0.0.0.0_all.deb 
-        sudo dpkg -i ../pwgrep_0.0.0.0_all.deb
-
-    Run
-
-        dpkg -L pwgrep
-
-    to see whats in there. You can now run
-
-        /usr/bin/pwgrep
-
-    or for example
-
-        man pwgrep
-
-  Read the Makefile
-    Read the Makefile in order to understand what's going on.
-
-Customize
-    Now, since you understood everything feel free to customize everything
-    the way you want it. E.g.:
-
-        Don't use POD for documentation but LaTeX
-
-        Compile a C program
-
-        Include a ./lib dir, add it to the 'install' Makefile rule
-
-        etc etc.
-
-    You should also consider the following:
-
-  Manual page
-    This template is using POD for creating manual pages. Edit
-    ./docs/pwgrep.pod and run
-
-        make documentation
-
-    in order to build ./docs/pwgrep.1. The page will be included in the
-    resulting debian package automatically. You can review the page with
-
-        man ./docs/pwgrep.1
-
-  Renaming pwgrep into your project name
-    Rename all files which have *pwgrep* included into your own new package
-    name. You can find them with
-
-        find . -name \*pwgrep\*
-
-    Search all content and rename *pwgrep* into your own new package name.
-    You can find all files with
-
-        grep -R pwgrep . | grep -v .git
-
-  Updating ./debian
-    Edit the following files accordingly to your new project (e.g. with
-    vim):
-
-        ./debian/control
-        ./debian/copyright
-        ./debian/README
-
-  Update changelog
-    Go to the to level directory and run
-
-        dch -i
+    pwgrep - Managing passwords...
+
+Synopsis
+      fwipe <FILE>            - Wiping a file
+      pwdbls                  - Listing available DBs
+      pwedit [OPTS]           - Editing current DB
+      pwfadd <FILE>           - Adding a file to FDB
+      pwfcat <NAME>           - Printing a file from filestore to stdout
+      pwfdel <NAME>           - Deleting a file from filestore
+      pwgrep [OPTS] <REGEX>   - Grepping current DB
+      pwldb                   - Synonym for pwdbls
+      pwupdate                - Updating FDB and all DBs
+      pwhelp                  - Printing this help screen
+
+    Where OPTS are: -o - Offline mode -d <DB NAME> - Using a specific DB -a
+    - Searching all available DBs or categories at once
+
+Tutorial
+    Please go to <http://pwgrep.buetow.org> .