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