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.CONF 5
16 e573cb09 2020-09-27 op .Os
17 e573cb09 2020-09-27 op .Sh NAME
18 e573cb09 2020-09-27 op .Nm star-platinum.conf
19 e573cb09 2020-09-27 op .Nd star-platinum configuration file
20 e573cb09 2020-09-27 op .Sh DESCRIPTION
21 e573cb09 2020-09-27 op .Nm
22 e573cb09 2020-09-27 op is the configuration file for the
23 e573cb09 2020-09-27 op .Xr star-platinum 1
24 e573cb09 2020-09-27 op program.
25 e573cb09 2020-09-27 op .Pp
26 e573cb09 2020-09-27 op Empty lines are ignored, and comments too.
27 e573cb09 2020-09-27 op Comments starts with a # sign and continue until the end of the line
28 e573cb09 2020-09-27 op and can be placed everywhere in the configuration file.
29 e573cb09 2020-09-27 op .Pp
30 e573cb09 2020-09-27 op The configuration file is made of blocks.
31 e573cb09 2020-09-27 op Every block starts with one or more
32 e573cb09 2020-09-27 op .Ic match
33 e573cb09 2020-09-27 op directives and continues with several keybinding directives.
34 e573cb09 2020-09-27 op If more than a single
35 e573cb09 2020-09-27 op .Ic match
36 e573cb09 2020-09-27 op directive is given, the keybinding will be used if at least one of the
37 e573cb09 2020-09-27 op .Ic match
38 e573cb09 2020-09-27 op directives matches the window.
39 e573cb09 2020-09-27 op That is, if both match class Firefox and match class Chromium is
40 e573cb09 2020-09-27 op given, the directives will be available for both Firefox and Chromium
41 e573cb09 2020-09-27 op windows.
42 e573cb09 2020-09-27 op .Pp
43 e573cb09 2020-09-27 op A keybinding directive is made of the
44 e573cb09 2020-09-27 op .Ic on
45 e573cb09 2020-09-27 op keyword followed by a keybinding, followed by the
46 e573cb09 2020-09-27 op .Ic do
47 e573cb09 2020-09-27 op keyword and an action.
48 e573cb09 2020-09-27 op The action can be another keybinding, or a special internal command.
49 e573cb09 2020-09-27 op .Pp
50 e573cb09 2020-09-27 op The syntax for the keybindings is inspired
51 e573cb09 2020-09-27 op .Xr emacs 1 .
52 e573cb09 2020-09-27 op A keybindings is written within double quotes and is made of modifiers
53 e573cb09 2020-09-27 op followed by the key.
54 e573cb09 2020-09-27 op Modifiers follows the
55 e573cb09 2020-09-27 op .Xr emacs 1
56 e573cb09 2020-09-27 op notation of using C- to mean control, S- for shift, M- for alt (mod1)
57 e573cb09 2020-09-27 op and s- for super (mod4).
58 e573cb09 2020-09-27 op The key can be either a plain letter (e.g. x) or the name of the key
59 e573cb09 2020-09-27 op written within angular brackets (e.g. <Down>).
60 e573cb09 2020-09-27 op .Pp
61 e573cb09 2020-09-27 op The only internal command available now is
62 e573cb09 2020-09-27 op .Ic ignore Ns : it's a no-op.
63 e573cb09 2020-09-27 op .Sh EXAMPLES
64 e573cb09 2020-09-27 op The following is an example of configuration file that binds some
65 e573cb09 2020-09-27 op .Xr emacs 1 Ns -esque keys for both Firefox and Chromium:
66 e573cb09 2020-09-27 op .Bd -literal -offset indent
67 e573cb09 2020-09-27 op match class Firefox
68 e573cb09 2020-09-27 op match class Chromium-browser
69 e573cb09 2020-09-27 op on "C-s" do "C-f"
70 e573cb09 2020-09-27 op 
71 e573cb09 2020-09-27 op # clipboard
72 e573cb09 2020-09-27 op on "C-w" do "C-x"
73 e573cb09 2020-09-27 op on "M-w" do "C-c"
74 e573cb09 2020-09-27 op on "C-y" do "C-v"
75 e573cb09 2020-09-27 op 
76 e573cb09 2020-09-27 op # movements
77 e573cb09 2020-09-27 op on "C-n" do "<Down>"
78 e573cb09 2020-09-27 op on "C-p" do "<Up>"
79 e573cb09 2020-09-27 op on "C-f" do "<Right>"
80 e573cb09 2020-09-27 op on "C-b" do "<Left>"
81 e573cb09 2020-09-27 op 
82 e573cb09 2020-09-27 op on "C-(" do ignore
83 e573cb09 2020-09-27 op .Ed