Crossfire Client, Trunk  R20789
chelp.h
Go to the documentation of this file.
1 /* Client helpfile */
2 
3 #ifndef CHELP_H
4 #define CHELP_H
5 
6 #define HELP_BIND_SHORT "bind a command to a key"
7 #define HELP_BIND_LONG "Syntax:\n\
8  bind [[-nframeg] <command>]\n\
9 \n\
10 Flags (default -nrfam):\n\
11  n - used in normal-mode\n\
12  f - used in fire-mode\n\
13  r - used in run-mode\n\
14  a - used with alt key\n\
15  m - used with meta key\n\
16  e - leave command in line edit\n\
17  g - global key (not recommended)\n\
18 Each client may not support every flag.\n\
19 \n\
20 bind without flags/command gets client help.\n\
21 \n\
22 Special 'commands':\n\
23  bind commandkey - sets commandkey\n\
24  bind firekey1 - sets first firekey\n\
25  bind firekey2 - sets second firekey\n\
26  bind runkey1 - sets first runkey\n\
27  bind runkey2 - sets second runkey\n\
28  bind prevkey - sets history-previous key\n\
29  bind nextkey - sets history-next key\n\
30  bind completekey - sets complete-command key\n\
31 \n\
32 Examples:\n\
33 bind -f cast paralyzed (F3)\n\
34  will typically mean that Shift-F3\n\
35  is used to select that spell (Shift\n\
36  being the fire key)\n\
37 \n\
38 bind -e shout (\")\n\
39  will put the cursor in the command\n\
40  box after writing 'shout' when you\n\
41  press double-quote. So you can shout\n\
42  to your friends easier. ;)\n"
43 
44 #define HELP_UNBIND_SHORT "unbind a command, show bindings"
45 #define HELP_UNBIND_LONG "Syntax:\n\
46  unbind [-g] [#]\n\
47  unbind reset\n\
48 Without -g command uses user's bindind,\n\
49 with -g global binding.\n\
50 Without number it displays current bindings,\n\
51 with # it unbinds it.\n\
52 'reset' resets default bindings."
53 
54 #define HELP_MAGICMAP_SHORT "show last received magic map"
55 #define HELP_MAGICMAP_LONG "Syntax:\n\
56  magicmap\n\
57 Displays last shown magic map."
58 
59 #define HELP_SAVEDEFAULTS_SHORT "save various defaults into ~/.crossfire/defaults"
60 #define HELP_SAVEDEFAULTS_LONG "Syntax:\n\
61  savedefaults\n\
62 Saves configuration."
63 
64 /* XXX *Which* configuration? */
65 
66 #define HELP_INV_SHORT "show clients inventory (debug)"
67 #define HELP_INV_LONG "Syntax:\n\
68  inv\n\
69 Debug info about inventory."
70 
71 
72 /* Used to be gchar, but it couldn't find it. */
73 /*
74 char * text = " === Client Side Commands: === \n\
75 \n\
76 bind - " HELP_BIND_SHORT "\n\
77 unbind - " HELP_UNBIND_SHORT "\n\
78 magicmap - " HELP_MAGICMAP_SHORT "\n\
79 savedefaults - " HELP_SAVEDEFAULTS_SHORT "\n\
80 inv - " HELP_INV_SHORT "\n\
81 \n\
82 \n\
83 bind\n\
84 \n\
85 " HELP_BIND_LONG "\n\
86 \n\
87 unbind\n\
88 \n\
89 " HELP_UNBIND_LONG "\n\
90 \n\
91 \n\
92  magicmap\n\
93 \n\
94 " HELP_MAGICMAP_LONG "\n\
95 \n\
96 \n\
97  savedefaults\n\
98 \n\
99 " HELP_SAVEDEFAULTS_LONG "\n\
100 \n\
101 \n\
102  inv\n\
103 \n\
104 " HELP_INV_LONG "\n\
105 \n\
106 \n\
107 ";
108 */
109 
110 #endif