Updated manpage

This commit is contained in:
2022-04-19 00:10:59 -04:00
parent 462ba05833
commit 7d14c49490
+14 -26
View File
@@ -1,4 +1,4 @@
.TH sshyp 1 "16 February 2022" "2022.02.16.fr4.7" "sshyp man page"
.TH sshyp 1 "19 April 2022" "v1.0" "sshyp man page"
.SH NAME
sshyp \- A very simple self-hosted, synchronized password manager. Alternative to GNU pass.
.SH SYNOPSIS
@@ -8,40 +8,33 @@ sshyp is a lightweight password and note management program written in Python. s
.SH EXAMPLES
Setting up sshyp for the first time or altering its configuration (also recommended after major updates):
sshyp tweak
*follow the prompts
Viewing the entry database:
sshyp
Reading an existing entry saved as ~/.password-pasture/development/github.gpg:
sshyp /development/github
Copying the password of an existing entry saved as ~/.password-pasture/financial/bank.gpg:
sshyp copy -p
*answer the prompt with "/financial/bank"
*enter decryption password
sshyp copy -p /financial/bank
Editing the username of an existing entry saved as ~/.password-pasture/game.gpg:
sshyp edit -u
*answer the first prompt with "game"
*follow the prompts
sshyp edit -u game
Making a new entry using the built-in password generator:
sshyp gen
*follow the prompts
Making a new entry saved as ~/.password-pasture/school/university.gpg using the built-in password generator:
sshyp gen /school/university
Creating a note-only entry:
sshyp add -n
*follow the prompts
Creating a note-only entry saved as ~/.password-pasture/notes/testNote.gpg:
sshyp add -n /notes/testNote
Syncing entries with the server:
Manually syncing entries with the server:
sshyp sync
Removing an existing folder saved as ~/.password-pasture/social:
sshyp shear
*when prompted for what to delete, since you are deleting a folder, be sure to enter your choice with a following "/", e.g. "social/" or "/social/"
sshyp shear social/
.SH OPTIONS
In order to quickly read an existing entry, just run "sshyp </entry name>".
Options for other operations are as follows:
USAGE: sshyp [OPTION [FLAG] [<entry name>]] | [</entry name>]
help/--help/-h bring up the help menu
version/-v display sshyp version info
@@ -71,13 +64,9 @@ copy:
gen:
update/-u generate a password for an existing entry
.SH LIMITATIONS
The following limitations will be corrected in future updates:
Currently, the entry list displays each entry with the file extension ".gpg" visible (which you do not type when reading, modifying, or creating an entry). This will be corrected when the new entry list is added.
The following characters/character sequences are not supported in entry/folder titles:
@ ^&*
@ ^&* *&^
.SH SETUP
sshyp operates on a client-server model, and thus requires you to have access to your own server (whether it be a physical home server or a cloud rental) with remote access via SSH.
@@ -94,7 +83,6 @@ Client setup:
Install sshyp
Run "sshyp tweak" and follow the prompts
Copy the generated public SSH key to the server using preferred method (manually adding to authorized_keys, ssh-copy-id, etc.)
**this step will be automated in the future: if an entry library already exists on the server, make sure to manually recreate any folders that exist on the server in the ~/.password-pasture directory
If you already have entries on the server, sync them using "sshyp sync"
Done!