forked from garglk/garglk
-
Notifications
You must be signed in to change notification settings - Fork 1
/
gargoyle.6
153 lines (153 loc) · 3.41 KB
/
gargoyle.6
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
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
.Dd November 24, 2022
.Dt GARGOYLE 6
.Os
.Sh NAME
.Nm gargoyle
.Nd interactive fiction player
.Aq Lk https://github.com/garglk/garglk
.Sh SYNOPSIS
.Nm
.Op Ar story
.Nm
.Fl d
.Fl \-dump-config
.Nm
.Fl e
.Fl \-edit-config
.Nm
.Fl m
.Fl \-migrate-config
.Nm
.Fl p
.Fl \-paths
.Op Ar story
.Nm
.Fl t
.Fl \-themes
.Sh DESCRIPTION
.Nm
is an interactive fiction player that supports all the major interactive fiction
formats, including:
.Pp
.Bl -bullet -offset indent -width 0 -compact
.It
AGT
.It
Adrift (excluding Adrift 5)
.It
AdvSys
.It
Alan 2 and 3
.It
Glulx
.It
Hugo
.It
JACL
.It
Level 9
.It
Magnetic Scrolls
.It
Scott Adams
.It
TADS 2 and 3
.It
Z\-machine
.El
.Pp
If
.Ar story
is provided, it will be played.
Otherwise, a file chooser will be displayed so a story can be selected.
.Pp
The following options are available:
.Bl -tag -width flag
.It Fl d , \-dump-config
Dump the default config file to standard output.
.It Fl e , \-edit-config
Open Gargoyle's configuration file in a text editor, first creating it
if necessary.
.It Fl m , \-migrate-config
Search for a move a legacy configuration file to the preferred location.
In general, on Unix systems, this will mean renaming
.Pa $HOME/.garglkrc
to
.Pa $HOME/.config/garglk.ini .
.It Fl p , \-paths
Display a list of configuration file paths as well as theme paths that
will be used at runtime.
If
.Ar story
is provided, game-specific configuration paths will be included.
.It Fl t , \-themes
Display a list of available color themes.
.El
.Sh CONFIGURATION
.Nm
is highly configurable, although all configuration is done through a text-based
configuration file.
To edit the configuration file, use
.Aq control-comma
while Gargoyle is running
.Po Aq command-comma
on Mac
.Pc ,
which will open the configuration file in a text editor.
The configuration file can also be edited directly.
The following locations are tried in order:
.Pp
.Bl -bullet -offset indent -width 0 -compact
.It
.Pa $XDG_CONFIG_HOME/garglk.ini
or
.Pa $HOME/.config/garglk.ini
.It
.Pa $HOME/.garglkrc
.El
.Pp
In addition, game-specific and directory-specific overrides are available.
For game-specific overrides, the game extension is removed and replaced with
.Pa ini .
For example,
.Pa zork1.z3
becomes
.Pa zork1.ini .
If this file exists, it will be treated as a configuration file.
For directory-specific overrides, if the file
.Pa garglk.ini
exists in the same directory as the game, it will be treated as a configuration
file.
.Pp
Finally, it is possible for a global configuration file to be installed.
This is often the file
.Pa /etc/garglk.ini ,
but this is configurable at build time, and may also be disabled.
.Pp
To see exactly which locations are being used, pass the
.Fl p
or
.Fl \-paths
flag to
.Nm .
Note that this will not include game- or directory-specific
configuration files.
.Pp
Configuration files are additive: first, the global configuration file is
parsed.
Next, the user's configuration file
.Po
such as
.Pa $HOME/.config/garglk.ini
.Pc
is parsed, with all of its provided options replacing whatever was specified in
the global configuration file.
Finally, if there is a directory-specific and/or game-specific configuration
file, their options will replace any existing options.
Configuration files need not provide all options.
This allows, for example, a game to select only the colors to be used, while
respecing all of the user's other choices.
.Sh AUTHORS
.An "Tor Andersson"
.An "Ben Cressey"
.An "Chris Spiegel" Aq [email protected]