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