1 e573cb09 2020-09-27 op .\" Copyright (c) 2020 Omar Polo <op@omarpolo.com>
 2 e573cb09 2020-09-27 op .\"
 3 e573cb09 2020-09-27 op .\" Permission to use, copy, modify, and distribute this software for any
 4 e573cb09 2020-09-27 op .\" purpose with or without fee is hereby granted, provided that the above
 5 e573cb09 2020-09-27 op .\" copyright notice and this permission notice appear in all copies.
 6 e573cb09 2020-09-27 op .\"
 7 e573cb09 2020-09-27 op .\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
 8 e573cb09 2020-09-27 op .\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
 9 e573cb09 2020-09-27 op .\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
10 e573cb09 2020-09-27 op .\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
11 e573cb09 2020-09-27 op .\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
12 e573cb09 2020-09-27 op .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
13 e573cb09 2020-09-27 op .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
14 e573cb09 2020-09-27 op .Dd $Mdocdate: September 27 2020$
15 e573cb09 2020-09-27 op .Dt STAR-PLATINUM 1
16 e573cb09 2020-09-27 op .Os
17 e573cb09 2020-09-27 op .Sh NAME
18 e573cb09 2020-09-27 op .Nm star-platinum
19 e573cb09 2020-09-27 op .Nd key translator for xorg
20 e573cb09 2020-09-27 op .Sh SYNOPSIS
21 e573cb09 2020-09-27 op .Nm
22 e573cb09 2020-09-27 op .Bk -words
23 e573cb09 2020-09-27 op .Op Fl dn
24 e573cb09 2020-09-27 op .Op Fl c Ar config
25 e573cb09 2020-09-27 op .Ek
26 e573cb09 2020-09-27 op .Sh DESCRIPTION
27 e573cb09 2020-09-27 op .Nm
28 e573cb09 2020-09-27 op is an utility to translate keybindings for X11 programs.
29 e573cb09 2020-09-27 op It acts by grabbing some keys, say control n, and send a fake events
30 e573cb09 2020-09-27 op when you press that sequence.
31 e573cb09 2020-09-27 op The fake event will be possibly a different key, depending on the
32 e573cb09 2020-09-27 op application that had the focus.
33 e573cb09 2020-09-27 op .Pp
34 e573cb09 2020-09-27 op The options are as follows:
35 e573cb09 2020-09-27 op .Bl -tag -width keyword
36 e573cb09 2020-09-27 op .It Fl c Ar conf
37 e573cb09 2020-09-27 op load the configuration from the given file instead of the default
38 e573cb09 2020-09-27 op .It Fl d
39 e573cb09 2020-09-27 op print the config (as parsed).
40 e573cb09 2020-09-27 op Useful for debugging
41 e573cb09 2020-09-27 op .It Fl n
42 e573cb09 2020-09-27 op config test mode
43 e573cb09 2020-09-27 op .El
44 e573cb09 2020-09-27 op .Sh CONFIGURATION FILE
45 e573cb09 2020-09-27 op If a configuration file is not given with the
46 e573cb09 2020-09-27 op .Fl c
47 e573cb09 2020-09-27 op option, the default behaviour is to search for
48 e573cb09 2020-09-27 op .Pa $HOME/.star-platinum.conf
49 e573cb09 2020-09-27 op or
50 e573cb09 2020-09-27 op .Pa $XDG_CONFIG_HOME/star-platinum.conf
51 e573cb09 2020-09-27 op (where
52 e573cb09 2020-09-27 op .Pa $XDG_CONFIG_HOME
53 e573cb09 2020-09-27 op if not defined is assumed
54 e573cb09 2020-09-27 op .Pa $HOME/.config )
55 e573cb09 2020-09-27 op .Sh SEE ALSO
56 e573cb09 2020-09-27 op .Xr star-platinum.conf 5
57 08932492 2020-10-01 op .Sh ENVIRONMENT
58 08932492 2020-10-01 op .Bl -tag -width keyword
59 08932492 2020-10-01 op .It Ev DISPLAY
60 08932492 2020-10-01 op the X11 display to use.
61 08932492 2020-10-01 op .It Ev HOME
62 08932492 2020-10-01 op the user home directory.
63 08932492 2020-10-01 op .\" XXX: keep in sync with star-platinum.conf.5
64 08932492 2020-10-01 op .It Ev SHELL
65 08932492 2020-10-01 op The user preferred shell.
66 08932492 2020-10-01 op If not provided
67 08932492 2020-10-01 op .Pa /bin/sh
68 08932492 2020-10-01 op is assumed.
69 08932492 2020-10-01 op This executable must accept a
70 08932492 2020-10-01 op .Fl c
71 08932492 2020-10-01 op flag to execute a string.
72 08932492 2020-10-01 op .It Ev XDG_CONFIG_HOME
73 08932492 2020-10-01 op used when searching for a configuration file.
74 08932492 2020-10-01 op If not provided
75 08932492 2020-10-01 op .Pa $HOME/.config
76 08932492 2020-10-01 op is assumed.
77 08932492 2020-10-01 op .El
78 f63db357 2020-11-05 op .Sh CAVEATS
79 f63db357 2020-11-05 op .Nm
80 f63db357 2020-11-05 op is unable to work with re-parenting window managers.