Skip to content

Commit c0a54ba

Browse files
committed
some additional documentation
1 parent 5597440 commit c0a54ba

File tree

1 file changed

+106
-0
lines changed

1 file changed

+106
-0
lines changed

doc/adwm.1.in

+106
Original file line numberDiff line numberDiff line change
@@ -1197,6 +1197,112 @@ The program could not execute and was not expecting to return from the
11971197
.Xr execve 3
11981198
instruction, and therefore, exited abnormally.
11991199
.El
1200+
.Sh ENVIRONMENT
1201+
The following environment variables are observed by
1202+
.Nm @PACKAGE_NAME@ :
1203+
.Pp
1204+
.Bl -tag -width "XX"
1205+
.It Cm DESKTOP_STARTUP_ID
1206+
.Nm @PACKAGE_NAME@
1207+
has been configured to automatically perform startup notification
1208+
completion on startup.
1209+
.It Cm DISPLAY
1210+
Used to determine X Display. When the
1211+
.Fl -display
1212+
options is specified, this environment variable will be set to the
1213+
specified value.
1214+
.It Cm HOME
1215+
Will be used to determine the user's home directory for the purpose of
1216+
calculating the default value for
1217+
.Cm XDG_CONFIG_HOME
1218+
and
1219+
.Cm XDG_DATA_HOME
1220+
when required. When unspecified, the home directory for the current
1221+
local user is determined from the password file. Failing that, the
1222+
current directory is used.
1223+
.It Cm HOSTNAME
1224+
Will be used to determine the local host name. When unspecified, the
1225+
name will be determined from the
1226+
.Xr gethostname 3
1227+
call. This value is used to determine the host for which to save
1228+
session files. Also, will be used to determine the default directory
1229+
for some configuration and commands.
1230+
.It Cm USER
1231+
Will be used to determine the name of the local user. When unspecified,
1232+
the user name for the current pid will be determined from the password
1233+
file and this environment variable will be set. Failing that, it will
1234+
not be set.
1235+
.It Cm XDG_RUNTIME_DIR
1236+
1237+
.It Cm XDG_CACHE_HOME
1238+
1239+
.It Cm XDG_CONFIG_DIRS
1240+
When set, the subdirectories
1241+
.Pa $DIRECTORY/@PACKAGE@
1242+
will be examined for each
1243+
.Pa $DIRECTORY
1244+
in the colon separated list of directories contained in
1245+
.Cm XDG_CONFIG_DIRS .
1246+
The variable defaults to
1247+
.Pa /etc/xdg .
1248+
When the
1249+
.Fl -vendor
1250+
option is specified, or defaults,
1251+
.Pa /etc/xdg/$VENDOR
1252+
is prefixed to the normal default.
1253+
.Pa /etc/xdg/xde
1254+
will always be prefixed to the result.
1255+
.It Cm XDG_CONFIG_HOME
1256+
.It Cm XDG_DATA_DIRS
1257+
.It Cm XDG_DATA_HOME
1258+
.It Cm XDG_ICON_THEME
1259+
.It Cm SESSION_MANAGER
1260+
.It Cm SM_SAVE_DIR
1261+
.El
1262+
.Sh SIGNALS
1263+
The following signals are handled by
1264+
.Nm @PACKAGE_NAME@ :
1265+
.Pp
1266+
.Bl -tag -width "XX" -compact
1267+
.It Ar SIGTERM
1268+
.Nm @PACKAGE_NAME@
1269+
will quit when it receives a
1270+
.Ar SIGTERM
1271+
signal.
1272+
.It Ar SIGINT
1273+
.Nm @PACKAGE_NAME@
1274+
will quit when it receives a
1275+
.Ar SIGINT
1276+
signal.
1277+
.It Ar SIGQUIT
1278+
.Nm @PACKAGE_NAME@
1279+
will quit when it receives a
1280+
.Ar SIGQUIT
1281+
signal.
1282+
.It Ar SIGHUP
1283+
.Nm @PACKAGE_NAME@
1284+
will reload when it receives a
1285+
.Ar SIGHUP
1286+
signal.
1287+
.It Ar SIGCHLD
1288+
.Nm @PACKAGE_NAME@
1289+
respects
1290+
.Ar SIGCHLD
1291+
and reaps children after they exit.
1292+
.It Ar SIGUSR1
1293+
(Reserved for additional function or feature.)
1294+
.It Ar SIGUSR2
1295+
(Reserved for additional function or feature.)
1296+
.It Ar SIGTTIN
1297+
.Nm @PACKAGE_NAME@
1298+
ignores job control signals.
1299+
.It Ar SIGTTOU
1300+
.Nm @PACKAGE_NAME@
1301+
ignores job control signals.
1302+
.It Ar SIGTSTP
1303+
.Nm @PACKAGE_NAME@
1304+
ignores job control signals.
1305+
.El
12001306
.Sh FILES
12011307
.Bl -tag -width "XX"
12021308
.It Pa ~/.@PACKAGE@/@PACKAGE@rc

0 commit comments

Comments
 (0)