android: Fix XML form filter.
[qpwmc.git] / README
blobe3bc1fc077b9d3f63d28386eb3fb933cffb51bf3
1 This is a full-featured pwmd (Password Manager Daemon) client using the Qt
2 toolkit to edit a pwmd data file.  You can use the Pwmd class easily in your
3 own application, too. Read pwmd.h and pwmdRemoteHost.h headers for details.
4 You can also also use qpwmc as a socket, data file and element selector by
5 spawning a qpwmc instance then parsing the result of the -d command line
6 switch.
9 Requirements:
10 -------------
11 libpwmd 8.3.0 or later (android: 8.4.0), pwmd 3.3.0 or later and Qt 6.x are
12 required.  Be sure that "disable_list_and_dump" is false in your pwmd
13 configuration file (the default).
16 Building:
17 ---------
18 Get the latest code by doing:
20 git clone https://gitlab.com/bjk/qpwmc.git
22 After cloning or after extracting an archive, do:
24   qmake6 WITH_CLANG=1 && make -j8
28   qmake6 && make -j8
30 The WITH_CLANG=1 will use the clang compiler but if clang is not installed on
31 your machine then you can omit that part.
33 After the build is complete, do:
35   make install
37 You can also create an installable debian package by instead doing:
39   qmake && make deb
41 Then use 'dpkg -i <package_name>' to install the package that was created in
42 the parent directory.
45 Usage:
46 ------
47 Be sure pwmd is running then run 'qpwmc'. This will have qpwmc sit in the
48 system tray. Double-click the icon to open the editor or right-click to edit
49 and select shortcuts. See -h for command line options.
51 There really isn't a standard for applications to follow when it comes to
52 element paths and element attributes but there are two element attributes that
53 qpwmc treats specially: the "password" and "hidden" attributes. The "password"
54 attribute tells qpwmc that an element content is a password and will be
55 presented specially by showing password input field along with a password
56 generator. Note that the content of an element with this attribute is only a
57 single line and not a full text area. For multi-line sensitive data, you can
58 enable the "Hidden" checkbox from the Content menu. This will also add the
59 "hidden" attribute for the element.
62 Issue tracker:
63 --------------
64 Please send any bug reports, feature requests or patches to the issue tracker
65 at Gitlab: https://gitlab.com/bjk/qpwmc/issues.
68 Ben Kibbey <bjk AT luxsci DOT net>
69 https://gitlab.com/bjk/qpwmc/wikis