A word from our sponsors

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision
Previous revision
sw:pwman3:intro [2017/09/14 06:13] Frank Fegertsw:pwman3:intro [2017/09/17 08:23] (current) Frank Fegert
Line 103: Line 103:
 | Global        | lock_timeout  | Integer       | Set the time period (in seconds) after which the database is locked.  | | Global        | lock_timeout  | Integer       | Set the time period (in seconds) after which the database is locked.  |
 | Database      | dburi         | Database URI according to [[https://tools.ietf.org/html/rfc3986|RFC3986]]     | SQLite, Postgreql, MySQL and MongoDB are currently supported. See below for examples.     | | Database      | dburi         | Database URI according to [[https://tools.ietf.org/html/rfc3986|RFC3986]]     | SQLite, Postgreql, MySQL and MongoDB are currently supported. See below for examples.     |
-| Updater   | supress_version_check | yes / no  | Check for newer versions of pwman3.       |+| Updater   | supress_version_check | yes / no  | Check for newer versions of //pwman3.//       |
 | Updater   | client_info           | string    | SHA256 digest of host name and username. Used for identifying the client. | | Updater   | client_info           | string    | SHA256 digest of host name and username. Used for identifying the client. |
 </sortable> </sortable>
Line 118: Line 118:
 ===== Initial Start ===== ===== Initial Start =====
  
-Upon inital start, pwman3 generates a new password database:+Upon inital start, //pwman3// generates a new password database:
  
 <cli> <cli>
Line 128: Line 128:
 </cli> </cli>
  
-The new password database is stored in the user-specific pwman3 directory, e.g.:+The new password database is stored in the user-specific //pwman3// directory, e.g.:
  
 <cli> <cli>
Line 136: Line 136:
 </cli> </cli>
  
 +===== Commands =====
  
 +The following -- partially synonymous -- commands are available within //pwman3//:
 +
 +^ Command                                                   ^ Description                                               ^
 +| ''EOF'', ''exit''                                         | Exit the application.                                     |
 +| ''clear''                                                 | Clears the filter criteria.                               |
 +| ''cls''                                                   | Clear the screen.                                         |
 +| ''copy'', ''cp''                                          | Copy password to X clipboard (//xsel// is required).      |
 +| ''delete'', ''rm''                                        | Deletes nodes. Multiple ids and nodes can be specifie , separated by a space. A range of ids can be specified in the format n-N.      |
 +| ''e'', ''edit''                                           | Edit a nodes.                                             |
 +| ''export [{'filename': '<file>', 'delimiter':'<char>'}]'' | All nodes under the current filter are exported.          |
 +| ''h [topic]'', ''help [topic]''                           | Print a help message for a command.                       |
 +| ''filter <tag>''                                          | Filter nodes on a given tag. One or more tags are allowed. Displays current list of tags if called without arguments.                                          |
 +| ''forget''                                                | Forget the database password for the current session.     |
 +| ''l <tag>'', ''list <tag>''                               | List nodes that match current or specified filter.        |
 +| ''n'', ''new''                                            | Creates a new node.                                       |
 +| ''o <ID>'', ''open <ID>''                                 | Launch default browser with ''xdg-open url'', for the given node id. Ihe URL must contain <nowiki>http://</nowiki> or <nowiki>https://</nowiki>   |
 +| ''passwd''                                                | Change the password on the database.                      |
 +| ''p <ID|tag>'', ''print <ID|tag>''                        | Display a node. ultiple ids and nodes can be specified, separated by a space.  A range of ids can be specified in the format n-N.     |
 +| ''save [filename]''                                       | Save the current configuration.                           |
 +| ''set [option] [value]''                                  | Set a configuration option. Display current value if no value is given. Display the complete configuration of option and value are omitted.   |
 +| ''tags''                                                  | Display all tags in used in the database.                 |
 +
 +===== Common Tasks =====
 +
 +Create a new password entry -- node -- in the database:
 +
 +<cli prompt='>'>
 +pwman> new
 +Username: username
 +Password (Blank to generate): 
 +[Repeat] Password (Blank to generate): 
 +Url:      http://www.bityard.org
 +Notes:    1st Test
 +Please enter your password:
 +Tags:     Web
 +</cli>
 +
 +List all nodes:
 +
 +<cli prompt='>'>
 +pwman> filter
 +Current tags: 
 +None
 +
 +pwman> ls
 +    1. username@http://www.bityard.org          Web
 +</cli>
 +
 +Print a node by its ID:
 +
 +<cli prompt='>'>
 +pwman> print 1
 +Node 1.
 + Username: username
 + Password: asdasdasd
 +      Url: http://www.bityard.org
 +    Notes: 1st Test
 +Tags: 
 + Web   
 +</cli>
 +
 +Filter nodes by a given tag:
 +
 +<cli prompt='>'>
 +pwman> ls
 +    1. username@http://www.bityard.org          Web
 +    2. root@                                    SSH
 +
 +pwman> filter Web
 +Current tags: 
 +Web   
 +
 +pwman> ls
 +    1. username@http://www.bityard.org          Web
 +</cli>
 +
 +Delete a node
 +
 +<cli prompt='>'>
 +pwman> ls
 +    1. username@http://www.bityard.org          Web
 +    2. root@                                    SSH
 +
 +pwman> delete 1
 +Are you sure you want to delete 'username@http://www.bityard.org' ([y/N])?y
 +username@http://www.bityard.org deleted
 +
 +pwman> ls
 +    2. root@                                    SSH
 +</cli>
  
 ===== Status Check ===== ===== Status Check =====