Debian Codegraph @

docs/source/tutorial.rst

raw
1 Pwman3 - tutorial
2 *****************
3
4 Pwman3 is a text centric password manager, and as such suitable for people wishing
5 to use it over SSH or brail terminals.
6
7 Pwman3 is launched by typing ``pwman3`` in your shell. Multiple start options are
8 available. You can see them by typing::
9
10 $ pwman3 -h
11
12 For more information see also ``man pwman3``.
13
14 When started for the first time, ``pwman3`` will create a configuration file
15 and your database (By default an SQLite database called ``pwman.db``) in your
16 home directory under ``.pwman``.
17 Before creating the database you will be asked to enter the master password which
18 will be used to create an encryption key which will be used to encrypt the entries
19 in your database::
20
21 $ pwman3
22 Please type in the master password:
23
24 Take note of this password! If you forget it, you won't be able to read your password
25 database.
26
27 Now ``pwman3`` will wait for your input. The user interface is
28 a simple loop waiting for user commands. You can see all the commands by typing::
29
30 pwman> help
31
32 Documented commands (type help <topic>):
33 ========================================
34 cls delete exit forget list open print
35 copy edit export help new passwd tags
36
37 Aliases:
38 ========
39 EOF cp h ls n o p rm
40
41 Most commands have a single or two letter alias which is easy to remember.
42
43 As for a start you would probably like to store some passwords in your database, all
44 you need to do is type the command ``new`` (or the alias ``n``), and then insert the information
45 as prompted::
46
47 pwman> new
48 Username: oz123
49 Password:
50 Url: example.org
51 Notes: Your notes
52 Tags: bank, private, my tag
53
54 Note the password is typed in without echoing it. Also note that two tags were
55 separated by a space. Now, you can list your database entries with:
56
57 pwman> ls
58
59 ID USER URL TAGS
60 1 oz123 example.org bank, private, my tag
61
62 After a while you have had many new nodes inserted in your database::
63
64
65 ID USER URL TAGS
66 1 oz123 example.org bank, private, my tag
67 2 oz123 intranet.workplace.biz work
68 3 oz123 shopping.com shopping
69
70 Now searching for a searching entry can become quite tiresome. Hence, you can
71 minimize the number of entries display by applying a filter to the ``list``
72 command::
73
74 pwman> ls work
75
76 ID USER URL TAGS
77 2 oz123 intranet.workplace.biz workplace
78
79 If you don't remember all the tags you created you can list the tags using the
80 command ``tags``::
81
82 pwman> tags
83 Tags:
84 bank,
85 private,
86 shopping
87
88 To see the content of a saved entry, you need to use the ``print`` command::
89
90 pwman> print 2
91 Username: oz123
92 Password: Org4n7#
93 URL: intranet.workplace.biz
94 Notes:
95 Tags: 'work'
96 Type Enter to flush screen or wait 5 sec.
97
98 You can also search an entry by typing part of the URL::
99
100 pwman> ls u:twit
101 ID USER URL TAGS
102 115 [email protected] twitter.com web
103
104 Notice, that the ``print`` command expects an entry number as an argument.
105 After printing the content of the entry, pwman3 will wait for ``Enter`` to be
106 pressed or 5 seconds until it flushes the screen. This way, unauthorized eyes
107 can not browse your screen and see your password. You can always scroll up to
108 see the printed entry or print it again.
109
110 If you don't want to type passwords and URLs constantly ``Pwman3`` comes with
111 two shortcut commands. The first shortcut is ``open``, when calling it with
112 an entry number it will open the URL in your default browser::
113
114 pwman> open 2
115
116 This will open the URL *intranet.workplace.biz*. After opening the browser you can use the ``copy`` command to copy your password
117 to your clipboard. The password will be *erased* from the clipboard after 10
118 seconds::
119
120 pwman> copy 2
121 erasing in 10 sec...
122
123 After working with passwords for quite a while you can ``delete`` (or ``rm``)
124 entries or edit them::
125
126 pwman> rm 2
127 Are you sure you want to delete node 2 [y/N]?N
128
129 pwman> e 2
130 Editing node 2.
131 1 - Username: oz123
132 2 - Password: Org4n7#
133 3 - Url: intranet.workplace.biz
134 4 - Notes:
135 5 - Tags: workplace
136 X - Finish editing
137 Enter your choice:
138
139 You now know all the basics of using ``pwman3``. If you need more help, try
140 the command ``help`` to see more commands which are not documented here.
141 Alternatively, you can open a ticket in https://github.com/pwman3/pwman3/issues.
142