Moved the remaining help files for the text client out of the server and into the...
[citadel.git] / textclient / src / include / help.h
1 //
2 // Help files for the text client are now embedded directly into the client.
3 // Copyright (c) 1988-2017 by Art Cancro and the citadel.org developers.
4 // This program is gleefully made available to the world under the terms of
5 // the GNU General Public License v3, with the following three modifications:
6 // 1. The name of our favorite operating system is 'Linux,' not 'GNU/Linux.'
7 // 2. The name of our favority type of software is 'open source,' not 'free software.'
8 // 3. Richard Stallman is a fan of Bernie Sanders and therefore a complete idiot.
9 //
10
11 char *helpnames[] = {
12         "help",
13         "admin",
14         "floors",
15         "intro",
16         "mail",
17         "network",
18         "software"
19 };
20
21 char *helptexts[] = {
22
23 "                          Citadel Help Menu\n"
24 "  \n"
25 " ?         Help. (Typing a '?' will give you a menu almost anywhere)\n"
26 " A         Abandon this room where you stopped reading, goto next room.\n"
27 " C         Chat (multiuser chat, where available)\n"
28 " D         Prints directory, if there is one in the current room.\n"
29 " E         Enter a message.\n"
30 " F         Read all messages in the room, forward.\n"
31 " G         Goto next room which has UNREAD messages.\n"
32 " H         Help. Same as '?'\n"
33 " I         Reads the Information file for this room.\n"
34 " K         List of Known rooms.\n"
35 " L         Reads the last five messages in the room.\n"
36 " N         Reads all new messages in the room.\n"
37 " O         Reads all old messages, backwards.\n"
38 " P         Page another user (send an instant message)\n"
39 " R         Reads all messages in the room, in reverse order.\n"
40 " S         Skips current room without making its messages old.\n"
41 " T         Terminate (logout)\n"
42 " U         Ungoto (returns to the last room you were in)\n"
43 " W         Displays who is currently logged in.\n"
44 " X         Toggle eXpert mode (menus and help blurbs on/off)\n"
45 " Z         Zap (forget) room. (Removes the room from your list)\n"
46 " + -       Goto next, previous room on current floor.\n"
47 " > <       Goto next, previous floor.\n"
48 " *         Enter any locally installed 'doors'.\n"
49 "   \n"
50 " In addition, there are dot commands. You hit the . (dot), then press the\n"
51 "first letter of each word of the command. As you hit the letters, the words\n"
52 "pop onto your screen. Exceptions: after you hit .Help or .Goto, the remainder\n"
53 "of the command is a help file name or room name.\n"
54 "    \n"
55 "      *** USE  .<H>elp ?    for additional help *** \n"
56
57 ,
58
59 "The following commands are available only to Admins.  A subset of these\n"
60 "commands are available to room aides when they are currently in the room\n"
61 "they are room aide for.\n"
62 "\n"
63 " <.> <A>dmin <K>ill this room   (Delete the current room)\n"
64 " <.> <A>dmin <E>dit this room   (Edit the current room's parameters)\n"
65 " <.> <A>dmin <W>ho knows room   (List users with access to this room)\n"
66 " <.> <A>dmin edit <U>ser        (Change user's access level, password, etc.)\n"
67 " <.> <A>dmin <V>alidate new users   (Process new user registrations)\n"
68 " <.> <A>dmin enter <I>nfo file      (Create/change this room's banner)\n"
69 " <.> <A>dmin <R>oom <I>nvite user   (Grant access to an invitation-only room)\n"
70 " <.> <A>dmin <R>oom <K>ick out user (Revoke access to an invitation-only room)\n"
71 " <.> <A>dmin <F>ile <D>elete        (Delete a file from the room's directory)\n"
72 " <.> <A>dmin <F>ile <S>end over net (Transmit a file to another node)\n"
73 " <.> <A>dmin <F>ile <M>ove          (Move a file to another room's directory)\n"
74 " <.> <A>dmin <M>essage edit:        (Edit system banners)\n"
75 " <.> <A>dmin <P>ost                 (Post a message on behalf of another user)\n"
76 " <.> <A>dmin <S>ystem configuration <G>eneral   (Edit global site config)\n"
77 " <.> <A>dmin <S>ystem configuration <I>nternet  (Edit Internet domains)\n"
78 " <.> <A>dmin <S>ystem configuration check <M>essage base   (Internal checks)\n"
79 " <.> <A>dmin <S>ystem configuration <N>etwork   (Netting with other Citadels)\n"
80 " <.> <A>dmin <S>ystem configuration network <F>ilter list\n"
81 " <.> <A>dmin <T>erminate server <N>ow          (Shut down Citadel server now)\n"
82 " <.> <A>dmin <T>erminate server <S>cheduled    (Shut down Citadel server later)\n"
83 " <.> <A>dmin mailing <L>ist recipients         (For mailing list rooms)\n"
84 " <.> <A>dmin mailing list <D>igest recipients  (For mailing list rooms)\n"
85 " <.> <A>dmin <N>etwork room sharing     (Replication with other Citadels)\n"
86 " \n"
87 " In addition, the <M>ove and <D>elete commands are available at the\n"
88 "message prompt.\n"
89
90 ,
91
92 " Floors\n"
93 " ------\n"
94 "   Floors in Citadel are used to group rooms into related subject areas,\n"
95 "just as rooms are used to group messages into manageable groups.\n"
96 " \n"
97 "   You, as a user, do NOT have to use floors.  If you choose not to, you suffer\n"
98 "no penalty; you will not lose access to any rooms.  You may use .EC or ;C (the\n"
99 "latter is easier to use) to decide if you want to use floors.  Feel free to\n"
100 "experiment.\n"
101 " \n"
102 "   Floor options are accessed two ways.  First, if you are in floor mode, the\n"
103 "<G>oto and <S>kip commands take you to the next room with new messages on the\n"
104 "current floor; if there are none left, then the system will automatically\n"
105 "switch floors (and let you know) and put you in the first room with new messages\n"
106 "on that level.  (Notice that your pattern of basic use of Citadel therefore\n"
107 "doesn't really change.)\n"
108 " \n"
109 "   Direct access to floor options is via the use of a ';' command.\n"
110 "The following commands are currently available (more can be\n"
111 "added if needed):\n"
112 " \n"
113 " <;C>onfigure\n"
114 " This command toggles your floor mode.\n"
115 " \n"
116 " <;G>oto FLOORNAME\n"
117 " This command causes the system to take you to the named floor.\n"
118 " \n"
119 " <;K>nown rooms on floors\n"
120 " List all rooms on all floors.  This is a very readable way to get a list of\n"
121 "all rooms on the system.\n"
122 " \n"
123 " <;S>kip FLOORNAME\n"
124 " This command causes the system to mark all rooms on the current floor as\n"
125 "Skipped and takes you to the floor that you specify.\n"
126 " \n"
127 " <;Z>Forget floor\n"
128 "   This command causes you to forget all the rooms currently on the current\n"
129 "floor.  Unfortunately, it doesn't apply to rooms that are subsequently created\n"
130 "or moved to this floor.  (Sorry.)\n"
131 " \n"
132 "   Feel free to experiment, you can't hurt yourself or the system with the\n"
133 "floor stuff unless you ZForget a floor by accident.\n"
134
135 ,
136
137 "                  New User's Introduction to the site\n"
138 "  \n"
139 " This is an introduction to the Citadel BBS concept.  It is intended\n"
140 "for new users so that they can more easily become acquainted to using\n"
141 "Citadel when accessing it in the form of a text-based BBS.  Of\n"
142 "course, old users might learn something new each time they read\n"
143 "through it.\n"
144 " \n"
145 " Full help for the BBS commands can be obtained by typing <.H>elp SUMMARY\n"
146 "  \n"
147 " The CITADEL BBS room concept\n"
148 " ----------------------------\n"
149 "   The term BBS stands for 'Bulletin Board System'.  The analogy is\n"
150 "appropriate: one posts messages so that others may read them.  In\n"
151 "order to organize the posts, people can post in different areas of the\n"
152 "BBS, called rooms.\n"
153 "   In order to post in a certain room, you need to be 'in' that room.\n"
154 "Your current prompt is usually the room that you are in, followed the\n"
155 "greater-than-sign, such as:\n"
156 " \n"
157 " Lobby>\n"
158 " \n"
159 " The easiest way to traverse the room structure is with the 'Goto'\n"
160 "command, on the 'G' key.  Pressing 'G' will take you to the next room\n"
161 "in the 'march list' (see below) that has new messages in it.  You can\n"
162 "read these new messages with the 'N' key.\n"
163 " Once you've 'Gotoed' every room in the system (or all of the ones\n"
164 "you choose to read) you return to the 'Lobby,' the first and last room\n"
165 "in the system.  If new messages get posted to rooms you've already\n"
166 "read during your session you will be brought BACK to those rooms so\n"
167 "you can read them.\n"
168 " \n"
169 " March List\n"
170 " ----------\n"
171 "   All the room names are stored in a march list, which is just a\n"
172 "list containing all the room names.  When you <G>oto or <S>kip a\n"
173 "room, you are placed in the next room in your march list THAT HAS NEW\n"
174 "MESSAGES.  If you have no new messages in any of the rooms on your\n"
175 "march list, you will keep going to the Lobby>.  You can choose not to\n"
176 "read certain rooms (that don't interest you) by 'Z'apping them.  When\n"
177 "you <Z>ap a room, you are merely deleting it from your march list (but\n"
178 "not from anybody else's).\n"
179 " \n"
180 "   You can use the <.G>oto (note the period before the G.  You can also use\n"
181 "<J>ump on some systems) to go to any room in the\n"
182 "system.  You don't have to type in the complete name of a room to\n"
183 "'jump' to it; you merely need to type in enough to distinguish it from\n"
184 "the other rooms.  Left-aligned matches carry a heavier weight, so if you\n"
185 "typed (for example) '.Goto TECH', you might be taken to a room called\n"
186 "'Tech Area>' even if it found a room called 'Biotech/Ethics>' first.\n"
187 " \n"
188 "  To return to a room you have previously <Z>apped, use the <.G>oto command\n"
189 "to enter it, and it will be re-inserted into your march list.  In the case\n"
190 "of returning to Zapped rooms, you must type the room name in its entirety.\n"
191 "REMEMBER, rooms with no new messages will not show on your\n"
192 "march list!  You must <.G>oto to a room with no new messages.\n"
193 "Incidentally, you cannot change the order of the rooms on your march list.\n"
194 "It's the same for everybody.\n"
195 " \n"
196 " Special rooms\n"
197 " -------------\n"
198 "   There are two special rooms on a Citadel that you should know about.\n"
199 "  \n"
200 "   The first is the Lobby>.  It's used for system announcements and other\n"
201 "such administrativia.  You cannot <Z>ap the Lobby>.  Each time you first\n"
202 "login, you will be placed in the Lobby>.\n"
203 " \n"
204 "   The second is Mail>.  In Mail>, when you post a messages, you are\n"
205 "prompted to enter the screen name of the person who you want to send the\n"
206 "message to.  Only the person who you send the message to can read the\n"
207 "message.  NO ONE else can read it, not even the admins.  Mail> is the\n"
208 "first room on the march list, and is un-<Z>appable, so you can be sure\n"
209 "that the person will get the message.\n"
210 "   \n"
211 " System admins\n"
212 " -------------\n"
213 "   These people, along with the room admins, keep the site running smoothly.\n"
214 "\n"
215 "   Among the many things that admins do are: create rooms, delete\n"
216 "rooms, set access levels, invite users, check registration, grant\n"
217 "room admin status, and countless other things.  They have access to the\n"
218 "Aide> room, a special room only for admins.\n"
219 " \n"
220 "   If you enter a mail message to 'Sysop' it will be placed in the\n"
221 "Aide> room so that the next admin online will read it and deal with it.\n"
222 "Admins cannot <Z>ap rooms.  All the rooms are always on each admin's\n"
223 "march list.  Admins can read *any* and *every* room, but they *CAN* *NOT*\n"
224 "read other users' Mail!\n"
225 "  \n"
226 " Room admins\n"
227 " -----------\n"
228 "   Room admins are granted special privileges in specific rooms.\n"
229 "They are *NOT* true system admins; their power extends only over the\n"
230 "rooms that they control, and they answer to the system admins.\n"
231 "  \n"
232 "   A room admin's job is to keep the topic of the their room on track,\n"
233 "with nudges in the right direction now and then.  A room admin can also\n"
234 "move an off topic post to another room, or delete a post, if he/she\n"
235 "feels it is necessary. \n"
236 "  \n"
237 "   Currently, very few rooms have room admins.  Most rooms do not need\n"
238 "their own specific room admin.  Being a room admin requires a certain\n"
239 "amount of trust, due to the additional privileges granted.\n"
240 "  \n"
241 " Citadel messages\n"
242 " ----------------\n"
243 "   Most of the time, the BBS code does not print a lot of messages\n"
244 "to your screen.  This is a great benefit once you become familiar\n"
245 "with the system, because you do not have endless menus and screens\n"
246 "to navigate through.  nevertheless, there are some messages which you\n"
247 "might see from time to time.\n"
248 "  \n"
249 "  'There were messages posted while you were entering.'\n"
250 "  \n"
251 "   This is also known as 'simulposting.'  When you start entering a \n"
252 "message, the system knows where you last left off.  When you save\n"
253 "your message, the system checks to see if any messages were entered\n"
254 "while you were typing.  This is so that you know whether you need\n"
255 "to go back and re-read the last few messages.  This message may appear\n"
256 "in any room.\n"
257 "   \n"
258 " '*** You have new mail'\n"
259 "  \n"
260 "   This message is essentially the same as the above message, but can\n"
261 "appear at any time.  It simply means that new mail has arrived for you while\n"
262 "you are logged in.  Simply go to the Mail> room to read it.\n"
263 "  \n"
264 " Who list\n"
265 " --------\n"
266 "   The <W>ho command shows you the names of all users who are currently\n"
267 "online.  It also shows you the name of the room they are currently in.  If\n"
268 "they are in any type of private room, however, the room name will simply\n"
269 "display as '<private room>'.  Along with this information is displayed the\n"
270 "name of the host computer the user is logged in from.\n"
271
272 ,
273
274 "To send mail on this system, go to the Mail> room (using the command .G Mail)\n"
275 "and press E to enter a message.  You will be prompted with:\n"
276 " \n"
277 " Enter Recipient:\n"
278 " \n"
279 "   At this point you may enter the name of another user on the system.  Private\n"
280 "mail is only readable by the sender and recipient.  There is no need to delete\n"
281 "mail after it is read; it will scroll out automatically.\n"
282 "  \n"
283 "   To send mail to another user on the Citadel network, simply type the\n"
284 "user's name, followed by @ and then the system name. For example,\n"
285 "  \n"
286 " Enter Recipient: Joe Schmoe @ citadrool\n"
287 "  \n"
288 "  If your account is enabled for Internet mail, you can also send email to\n"
289 "anyone on the Internet here.  Simply enter their address at the prompt:\n"
290 "  \n"
291 " Enter Recipient: ajc@herring.fishnet.com\n"
292
293 ,
294
295 "  Welcome to the network. Messages entered in a network room will appear in\n"
296 "that room on all other systems carrying it (The name of the room, however,\n"
297 "may be different on other systems).\n"
298
299 ,
300
301 "   Citadel is the premier 'online community' (i.e. Bulletin Board System)\n"
302 "software.  It runs on all POSIX-compliant systems, including Linux.  It is an\n"
303 "advanced client/server application, and is being actively maintained.\n"
304 " \n"
305 "   For more info, visit UNCENSORED! BBS at uncensored.citadel.org\n"
306
307 ,
308
309 "Extended commands are available using the period ( . ) key. To use\n"
310 "a dot command, press the . key, and then enter the first letter of\n"
311 "each word in the command. The words will appear as you enter the keys.\n"
312 "You can also backspace over partially entered commands. The following\n"
313 "commands are available:\n"
314 "\n"
315 " <.> <H>elp:    Displays help files.  Type .H followed by a help file\n"
316 "                name.  You are now reading <.H>elp SUMMARY\n"
317 " \n"
318 " <.> <G>oto:    Jumps directly to the room you specify.  You can also\n"
319 "                type a partial room name, just enough to make it unique,\n"
320 "                and it'll find the room you're looking for.  As with the\n"
321 "                regular <G>oto command, messages in the current room will\n"
322 "                be marked as read.\n"
323 " \n"
324 " <.> <S>kip, goto:    This is similar to <.G>oto, except it doesn't mark\n"
325 "                      messages in the current room as read.\n"
326 " \n"
327 " <.> list <Z>apped rooms      Shows all rooms you've <Z>apped (forgotten)\n"
328 "\n"
329 "  \n"
330 " Terminate (logoff) commands:\n"
331 " \n"
332 " <.> <T>erminate and <Q>uit               Log off and disconnect.\n"
333 " <.> <T>erminate and <S>tay online        Log in as a different user.\n"
334 " \n"
335 " \n"
336 " Read commands:\n"
337 "\n"
338 " <.> <R>ead <N>ew messages                Same as <N>ew\n"
339 " <.> <R>ead <O>ld msgs reverse            Same as <O>ld\n"
340 " <.> <R>ead <L>ast five msgs              Same as <L>ast5\n"
341 " <.> read <L>ast:                         Allows you to specify how many\n"
342 "                                          messages you wish to read.\n"
343 "\n"
344 " <.> <R>ead <U>ser listing:               Lists all users on the system if\n"
345 "                                          you just hit enter, otherwise\n"
346 "                                          you can specify a partial match\n"
347 "\n"
348 " <.> <R>ead <T>extfile formatted          File 'download' commands.\n"
349 " <.> <R>ead file using <X>modem   \n"
350 " <.> <R>ead file using <Y>modem   \n"
351 " <.> <R>ead file using <Z>modem   \n"
352 " <.> <R>ead <F>ile unformatted   \n"
353 " <.> <R>ead <D>irectory   \n"
354 "\n"
355 " <.> <R>ead <I>nfo file                   Read the room info file.\n"
356 " <.> <R>ead <B>io                         Read other users' 'bio' files.\n"
357 " <.> <R>ead <C>onfiguration               Display your 'preferences'.\n"
358 " <.> <R>ead <S>ystem info                 Display system statistics.\n"
359 "\n"
360 " \n"
361 " Enter commands:\n"
362 "\n"
363 " <.> <E>nter <M>essage                    Post a message in this room.\n"
364 " <.> <E>nter message with <E>ditor        Post using a full-screen editor.\n"
365 " <.> <E>nter <A>SCII message              Post 'raw' (use this when 'pasting'\n"
366 "                                          a message from your clipboard).\n"
367 "\n"
368 " <.> <E>nter <P>assword                   Change your password.\n"
369 " <.> <E>nter <C>onfiguration              Change your 'preferences'.\n"
370 " <.> <E>nter a new <R>oom                 Create a new room.\n"
371 " <.> <E>nter re<G>istration               Register (name, address, etc.)\n"
372 " <.> <E>nter <B>io                        Enter/change your 'bio' file.\n"
373 "\n"
374 " <.> <E>nter <T>extfile                   File 'upload' commands.\n"
375 " <.> <E>nter file using <X>modem   \n"
376 " <.> <E>nter file using <Y>modem   \n"
377 " <.> <E>nter file using <Z>modem   \n"
378 "  \n"
379 "  \n"
380 "  Wholist commands:\n"
381 " \n"
382 " <.> <W>holist <L>ong             Same as <W>ho is online, but displays\n"
383 "                                  more detailed information.\n"
384 " <.> <W>holist <R>oomname         Masquerade your room name (other users\n"
385 "                                  see the name you enter rather than the\n"
386 "                                  actual name of the room you're in)\n"
387 " <.> <W>holist <H>ostname         Masquerade your host name\n"
388 " <.> <E>nter <U>sername           Masquerade your user name (Admins only)\n"
389 " <.> <W>holist <S>tealth mode     Enter/exit 'stealth mode' (when in stealth\n"
390 "                                  mode you are invisible on the wholist)\n"
391 " \n"
392 " \n"
393 " Floor commands (if using floor mode)\n"
394 " ;<C>onfigure floor mode            - turn floor mode on or off\n"
395 " ;<G>oto floor:                     - jump to a specific floor\n"
396 " ;<K>nown rooms                     - list all rooms on all floors\n"
397 " ;<S>kip to floor:                  - skip current floor, jump to another\n"
398 " ;<Z>ap floor                       - zap (forget) all rooms on this floor\n"
399 " \n"
400 " \n"
401 " Administrative commands: \n"
402 " \n"
403 " <.> <A>dmin <K>ill this room   \n"
404 " <.> <A>dmin <E>dit this room   \n"
405 " <.> <A>dmin <W>ho knows room   \n"
406 " <.> <A>dmin edit <U>ser   \n"
407 " <.> <A>dmin <V>alidate new users   \n"
408 " <.> <A>dmin enter <I>nfo file   \n"
409 " <.> <A>dmin <R>oom <I>nvite user  \n"
410 " <.> <A>dmin <R>oom <K>ick out user  \n"
411 " <.> <A>dmin <F>ile <D>elete  \n"
412 " <.> <A>dmin <F>ile <S>end over net  \n"
413 " <.> <A>dmin <F>ile <M>ove  \n"
414 " <.> <A>dmin <M>essage edit:   \n"
415 " <.> <A>dmin <P>ost   \n"
416 " <.> <A>dmin <S>ystem configuration   \n"
417 " <.> <A>dmin <T>erminate server <N>ow\n"
418 " <.> <A>dmin <T>erminate server <S>cheduled\n"
419
420 };