ggz-config(6)

1ggz-config(6)                   GGZ Gaming Zone                  ggz-config(6)
2
3
4

NAME

6       ggz-config - GGZ Gaming Zone configuration manager
7

SYNOPSIS

9       Query Mode:
10       ggz-config  [--configdir]  [--gamedir] [--datadir] [--protocol] [--ver‐
11       sion]
12
13       Install Mode:
14       ggz-config --install --modfile=FILENAME [--destdir] [--force]
15
16       Uninstall Mode:
17       ggz-config --remove --modfile=FILENAME
18
19       Repair Mode:
20       ggz-config --check
21

DESCRIPTION

23       The program ggz-config is  a  central  tool  and  part  of  the  client
24       libraries  package  of the GGZ Gaming Zone.  It can be used for several
25       purposes.  Primarily it is used to maintain the ggz.modules  configura‐
26       tion  file by installing and removing game module information.  This is
27       done with the --install and --remove modes of operation.
28
29       Additionally, the program can query the installation  settings  of  the
30       GGZ  client  libraries  to assist in configuring the build process of a
31       client or game module.
32

OPTIONS

34       Query Mode Options
35
36       -c, --configdir
37              Output location of the GGZ client libraries configuration direc‐
38              tory  and  exit.  This value will usually be @ggzconfdir@ and is
39              where the file ggz.modules is located.
40
41       -g, --gamedir
42              Output location of the executable game modules and  exit.   Game
43              modules  in  this  directory  are all game clients which are not
44              installed into a standard PATH directory,  mostly  because  they
45              only run when invoked by a GGZ core client. As a special module,
46              the game client wrapper ggzwrap is installed  into  this  place.
47              The gamedir is usually @ggzexecmoddir@.
48
49       -d, --datadir
50              Output location of game module data directory and exit.  This is
51              where games look for their graphics and level data.   This  will
52              likely resolve to @ggzdatadir@.
53
54       -p, --protocol
55              Query  GGZ_CS_PROTO_VERSION  -  version of core protocol between
56              the GGZ server and any GGZ core clients.
57
58       -h, --help
59              Output help information and exit.
60
61       -u, --usage
62              Print some ggz-config usage scenarios for quick reference.
63
64       -v, --version
65              Output version information and exit.
66
67       Install Mode Options
68
69       --install
70              Specifies that we are installing a game module description.
71
72       --modfile=FILENAME
73              Specifies the source module  description  file.   FILENAME  will
74              often be named module.dsc, but this is merely a convention.
75
76       --force
77              Overwrite  an existing module entry of the same name, author and
78              version rather than returning an error.
79
80       -D, --destdir
81              Specifies that the  $DESTDIR  environment  variable  contains  a
82              directory  to  prepend to the path for the GGZ module configura‐
83              tion file (ggz.modules).  The only known purpose for this is for
84              creating binary packages of GGZ games.
85
86       Uninstall Mode Options
87
88       --remove
89              Specifies that we are removing a game module description.
90
91       --modfile=FILENAME
92              Specifies the source module description file.
93

FILES

95       @ggzconfdir@/ggz.modules
96              Game module registry for all GGZ Gaming Zone core clients.
97

ENVIRONMENT VARIABLES

99       DESTDIR
100              Used during install process, most commonly by the build sequence
101              of binary packages such as rpm or dpkg.
102

BUGS

104       The program is currently unable to  detect  many  problems  that  could
105       arise with an invalid ggz.modules file.
106
107       Probably others, too numerous to mention.
108

AUTHORS

110       The GGZ Development Team <ggz-dev@mail.ggzgamingzone.org>
111