qpwmc.1

   1 .\" Copyright (C) 2016-2021 Ben Kibbey <bjk@luxsci.net>
   2 .\"
   3 .\" This file is part of qpwmc.
   4 .\"
   5 .\" This library is free software; you can redistribute it and/or
   6 .\" modify it under the terms of the GNU Lesser General Public
   7 .\" License as published by the Free Software Foundation; either
   8 .\" version 2.1 of the License, or (at your option) any later version.
   9 .\"
  10 .\" This library is distributed in the hope that it will be useful,
  11 .\" but WITHOUT ANY WARRANTY; without even the implied warranty of
  12 .\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13 .\" Lesser General Public License for more details.
  14 .\"
  15 .\" You should have received a copy of the GNU Lesser General Public
  16 .\" License along with this library; if not, write to the Free Software
  17 .\" Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301
  18 .\" USA
  19 .de URL
  20 \\$2 \(laURL: \\$1 \(ra\\$3
  21 ..
  22 .if \n[.g] .mso www.tmac
  23 .TH QPWMC 1 "26 Feb 2021" "0.6.4" "QPwmc"
  24 .SH NAME
  25
  26 qpwmc \- A graphical pwmd client.
  27 .SH SYNOPSIS
  28 .B qpwmc
  29 [-hvy] [-s <socket>] [-e <filename>] [-t <form>] [-d <fd>] [-p <path>]
  30
  31 .SH DESCRIPTION
  32 .B qpwmc
  33 is a graphical
  34 .BR libpwmd (3)
  35 client and editor for
  36 .BR pwmd (1)
  37 using the Qt toolkit. It supports all features of libpwmd and pwmd with the
  38 ability to create needed elements for various applications by filling out a
  39 form using a wizard.  It can also use the system tray to select a shortcut
  40 that fetches an elements' content and copies it to the clipboard. See the
  41 .B -y
  42 command line switch for details.
  43
  44 .SH OPTIONS
  45 .TP
  46 .I "\-s <socket>"
  47 The pwmd socket to connect to. A configured remote host name may also be used
  48 as the socket. Socket configuration is done in the Socket->Options menu item.
  49 When not specified the previously used socket is connected to. Only useful
  50 with the
  51 .B -e
  52 and
  53 .B -f
  54 switches.
  55
  56 .TP
  57 .I "\-e <filename>"
  58 When this option is specified the main editing window is opened for the
  59 specified filename. By default, qpwmc starts as an icon in the system tray but
  60 right-clicking on the tray icon gives the option to edit the last used data
  61 file or the ability to create a new or open another data file.
  62
  63 .TP
  64 .I "\-y"
  65 Start in the system tray rather than opening the editor. When in the system
  66 tray, element shortcuts can be edited and selected. When selected, the content
  67 of the shortcut element path is copied to the clipboard then cleared after the
  68 configured timeout. The system tray mode is enabled with this switch or in the
  69 editor Preferences dialog.
  70
  71 .TP
  72 .I "\-f <filename>"
  73 Loads an application form to create needed application elements.
  74
  75 .TP
  76 .I "\-p <path>"
  77 The initial element path to select when editing a datafile.
  78
  79 .TP
  80 .I "\-d <fd>"
  81 QPwmc can act as an element, socket and data file chooser when called from
  82 another application. When this option is specified, qpwmc will write a line
  83 containing the state of the editor to the specified file descriptor before
  84 exiting. The application can then parse this information to determine which
  85 socket parameters and data file to use for future pwmd connections.
  86
  87 .TP
  88 .I "\-h"
  89 Show available command line options and exit.
  90
  91 .TP
  92 .I "\-v"
  93 Show version information and exit.
  94
  95
  96 .SH FILES
  97 .TP
  98 .B /usr/local/share/qpwmc
  99 Default location of application forms.
 100
 101 .SH AUTHOR
 102 Ben Kibbey <bjk@luxsci.net>
 103 .br
 104 .URL "https://gitlab.com/bjk/qpwmc" "QPwmc homepage" .
 105
 106 .SH "SEE ALSO"
 107 .BR pwmd (1),
 108 .BR pwmc (1),
 109 .BR libpwmd (3)