4 # This file allows full customization of the user interface.
6 # The standard client looks for this file in:
8 # 2. <compiled CTDLDIR>/citadel.rc
10 # 4. <current directory>/citadel.rc
12 # Set ENCRYPT to yes to force SSL/TLS encryption when connecting to a
13 # Citadel server, even if the server is on the same machine as the
14 # client. Set it to no to disable SSL/TLS encryption. The default is to
15 # enable encryption for remote systems and to disable encryption for
16 # systems on the same machine as the client.
19 # Set FULLSCREEN to yes to (attempt to) use full-screen curses mode.
20 # This mode presents a status line and a few other niceties. Some
21 # people might not like this, so you can turn it off here or with the
22 # -s command line option. The default is to use full screen if the
23 # terminal supports it.
26 # Set EDITOR to the name of an external editor to be used for entering
27 # messages. If you want the external editor to be used by default, be sure
28 # to reflect this in the command set below.
32 # Or, you could have multiple editors available, like this:
33 # ("editor" and "editor0" are the same internally)
34 # You can go up to MAX_EDITORS number of editors (5 by default)
39 # If you define PRINTCMD, it will be a pipe through which messages are
40 # printed when the user hits the <P>rint key after a message.
44 # If you define EXPCMD, it will be a pipe through which any incoming
45 # express messages will be printed.
46 #expcmd=xmessage -title "Express Message" -center -buttons OK -file -
48 # If LOCAL_SCREEN_DIMENSIONS is set to 1, then the screen dimensions will
49 # be requested from the underlying operating system instead of asking the
50 # user. On modern networks this is almost always the case: telnet, SSH,
51 # xterm, and Unix/Linux consoles all properly report the screen dimensions.
52 # Set this option to 0 only if you are running the Citadel client on a
53 # direct-dial modem or hardwired terminals.
55 local_screen_dimensions=1
57 # ANSI_COLOR should be set to on/off/auto/user to control the use of
58 # color on the screen. If it is set to "auto" then an autodetect will be
59 # attempted. If it is set to "user" then it's a user-configurable option.
63 # USE_BACKGROUND controls Citadel's use of the background. If it is turned
64 # off, then Citadel will set the background to black. When it is turned on,
65 # the background will be unchanged. This is most useful with "transparent"
66 # terminals. Color must be on (see above) or this option has no effect.
70 # PROMPT_CONTROL should be set to on/off/user to control whether the <N>ext
71 # and <S>top keys are active when displaying the paginator prompt. If it
72 # is set to "user" then it's a user-configurable option.
76 # If DISPLAY_MESSAGE_NUMBERS is set to 1, then messages will be displayed
77 # with their message numbers in the header. This is ugly but some
78 # people seem to like it anyway...
80 display_message_numbers=0
82 # The FORCE_MAIL_PROMPTS directive causes mail rooms to always display a
83 # prompt after each message, even if the user has prompts turned off.
87 # USE_FLOORS determines whether the user sees floors, or a flat room space.
88 # Set it to YES to always use floors, NO to never use floors, or DEFAULT
89 # to use the setting in the user's configuration (which is normally the case).
93 # BEEP should be set to 1 if you wish the terminal to beep when an express
94 # message (page) comes in, otherwise set it to 0.
98 # ALLOW_ATTACHMENTS should be set to 1 if you wish the user to be able to
99 # attach files to messages and/or save attachments to disk while reading
100 # messages. (DANGER: do NOT enable this for "safe" public clients!)
104 # IDLE_THRESHOLD is the amount of time a user does nothing before being
105 # listed as "idle" on the who list. The default is 900 seconds (15 minutes).
109 # If you set REMEMBER_PASSWORDS to 1, the Citadel client will offer to
110 # remember your user name and password for every Citadel server you access,
111 # automatically logging in with them on subsequent visits.
112 # (DANGER: do NOT enable this for "safe" public clients!)
116 # Optionally, you can force the same username and password everywhere. This
117 # obviously isn't as robust as the password manager.
119 #username=My User Name
122 # If URLCMD is defined, users can hit 'U' after reading a message which
123 # contains embedded URL's, and the command will be executed. Usually this
124 # will be used to remote-control a web browser. (Do not enable this command
125 # for 'safe' public clients.)
127 # This one ought to work on any Linux that has the "Portland" API's installed.
128 # If properly configured, xdg-open will open the URL in the user's perferred
130 #urlcmd=xdg-open "%s"
132 # This one works on non-Portland Linux and most other X11-based Unices.
133 # Specify the full path to Firefox if necessary.
134 #urlcmd=/usr/bin/firefox -a firefox -remote "openURL(%s)" >/dev/null 2>&1
136 # This one works really well on a Macintosh -- it opens URL's in whatever
137 # browser you have configured as the system default.
140 # If GOTMAILCMD is defined, the specified command will be executed. This
141 # might be nice for playing sounds or providing any other type of notification.
143 #gotmailcmd=play gotmail.wav
145 # If IMAGECMD is defined, users can hit 'I' to view images attached to a
146 # message. (Do not enable this command for public clients.)
148 # Possible image viewers follow
150 # xdg-open - on Linux systems with the Portland API's installed, this ought
151 # to open the image in the user's preferred viewer.
152 #imagecmd=xdg-open "%s"
154 # XV - This is an oldie but goodie, shareware with source code included, no
155 # longer included with some Linux distributions due to licensing.
158 # The following 2 image viewers are included with KDE:
159 # KuickShow has a brightness/gamma option and is simple and ubobtrusive
160 #imagecmd=kuickshow "%s"
162 # KView has no brightness/gamma but can do some minimal cropping and clipboard
166 # Eye of Gnome, the Gnome/Nautilus image viewer component (bare bones
170 # GIMP is a free-software attempt at a PhotoShop-like application.
173 # Preview on Mac OS X
174 #imagecmd=/Applications/Preview.app/Contents/MacOS/Preview "%s"
176 # MESSAGE READING SEMANTICS (experimental)
178 # A new set of message reading semantics is now available. If you set
179 # alternate_semantics, the following changes are made:
181 # * Messages are marked as read when you read them, rather than when you
182 # leave the room. This means read <N>ew will display a new message
183 # at most once, unless last old on new is turned on.
184 # * Reading <F>orward or <R>everse does not mark messages as read.
185 # * When you leave a room with <G>oto, <J>ump, etc., only messages that
186 # were in the room when you arrived are marked as read. The original
187 # semantics mark all messages read that were in the room at the time
188 # you leave the room. This occasionally causes messages to be "lost."
189 # * When you leave with <T>erminate, no additional messages are marked
191 # * The <S>kip and <A>bandon commands are reversed.
193 # This set of semantics should make Citadel easier to use on very busy
194 # systems, where many messages may be posted while reading. Users
195 # accustomed to D.O.C. or its variants will want to set this option.
197 alternate_semantics=no
201 # COMMAND SET CONFIGURATION
203 # All lines starting with "cmd=" are considered to be commands. This allows
204 # mapping of keytstrokes to various functions of the client.
206 # Format of each line:
207 # cmd_num,access,keystrokes
209 # Keep a copy of the original version of this file around as a reference
210 # for the command numbers. They are not documented anywhere else.
212 # Access is: 0 (all users), 1 (aides or room aides), 2 (aides only).
213 # Please be aware that it is futile to attempt to gain unauthorized access to
214 # the administrative functions of the system by changing all the access levels
215 # to 0. If you do this, you'll simply be able to enter a lot of commands that
216 # will fail at the server ... so don't bother trying. :-)
218 # The actual key to be pressed should be prefaced with an & (ampersand)
219 # character. Ampersands are interesting and useful characters and you should
220 # use them as much as possible. Commands requiring more than one keystroke
221 # should be entered as multiple fields.
223 # If the last keystroke string ends with a : (colon), then the command
224 # will finish by allowing the user to enter a string.
226 # In keystroke names, the string ^r will be replaced by the name of the
227 # current room. The string ^c will be replaced by a comma.
229 # Commands may contain no more than five keystrokes.
231 # Note that the following characters are illegal in commands:
232 # , (comma) : (colon) ^ (caret) & (ampersand)
240 # If you want to use an external editor by default, set <E>nter message
241 # to command #46 (external editor) instead of #4 (built-in editor).
242 cmd=4,0,&Enter message
246 cmd=7,0,&Zap (forget) room
248 cmd=9,0,&Last five msgs
249 cmd=10,0,read &Forward
250 cmd=11,0,read &Reverse
253 cmd=14,0,read &Directory
257 cmd=17,0,&Who is online
258 cmd=47,0,&Abandon ^r^c goto...
259 #cmd=90,0,&Abandon ^r^c goto:
260 cmd=50,0,toggle e&Xpert mode
261 cmd=49,0,read &Info file
263 cmd=19,0,&.,list &Zapped rooms
264 cmd=52,0,&.,&Skip ^r^c goto:
265 cmd=56,0,&Page a user
269 # We implement both <.G>oto and <J>ump commands which do the same thing, in
270 # order to please a wider audience of users. Remove one if you want to.
276 cmd=22,1,&.,&Aide,&Kill this room
277 cmd=23,1,&.,&Aide,&Edit this room
278 cmd=24,0,&.,&Aide,&Who knows room
279 cmd=25,2,&.,&Aide,&User,&Edit
280 cmd=96,2,&.,&Aide,&User,&Delete
281 cmd=26,2,&.,&Aide,&Validate new users
282 cmd=48,1,&.,&Aide,enter &Info file
283 cmd=27,0,&.,&Aide,&Room,&Invite user
284 cmd=28,0,&.,&Aide,&Room,&Kick out user
285 cmd=51,1,&.,&Aide,&File,&Delete
286 cmd=53,1,&.,&Aide,&File,&Send over net
287 cmd=54,1,&.,&Aide,&File,&Move
288 cmd=70,2,&.,&Aide,&Message edit:
289 cmd=78,1,&.,&Aide,&Post
290 cmd=80,2,&.,&Aide,&System configuration,&General
291 cmd=82,2,&.,&Aide,&System configuration,&Internet
292 cmd=83,2,&.,&Aide,&System configuration,check &Message base
293 cmd=88,2,&.,&Aide,&System configuration,&Network
294 cmd=92,2,&.,&Aide,&System configuration,network &Filter list
295 cmd=85,2,&.,&Aide,&Terminate server,&Now
296 cmd=86,2,&.,&Aide,&Terminate server,&Scheduled
297 cmd=87,1,&.,&Aide,mailing &List recipients
298 cmd=94,1,&.,&Aide,mailing list &Digest recipients
299 cmd=89,1,&.,&Aide,&Network room sharing
301 cmd=29,0,&.,&Terminate,and &Quit
302 cmd=30,0,&.,&Terminate,and &Stay online
304 # The 'read user listing' command accepts two different formats. The one with
305 # the trailing colon allows the user to enter a few characters to search for
306 # users with a partial match.
308 #cmd=32,0,&.,&Read,&User listing
309 cmd=32,0,&.,&Read,&User listing:
311 cmd=33,0,&.,&Read,&Textfile formatted
313 # Command 55 allows the user to save a downloaded file directly to the
314 # computer running the client software. It is appropriate for a copy of
315 # this client running on the user's own computer. It is NOT appropriate for
316 # public copies of the client that people will be dialing into.
318 #cmd=55,0,&.,&Read,&File
320 # Commands 34, 43, and 45 are appropriate for public copies of the client for
321 # dialup use. They transfer downloaded files to a temporary file and then
322 # send them along to a dialup user using the popular protocols.
324 cmd=34,0,&.,&Read,file using &Xmodem
325 cmd=43,0,&.,&Read,file using &Ymodem
326 cmd=45,0,&.,&Read,file using &Zmodem
327 cmd=31,0,&.,&Read,&File unformatted
329 cmd=13,0,&.,&Read,&New messages
330 cmd=12,0,&.,&Read,&Old msgs reverse
331 cmd=71,0,&.,read &Last:
332 cmd=9,0,&.,&Read,&Last five msgs
333 cmd=14,0,&.,&Read,&Directory
334 cmd=49,0,&.,&Read,&Info file
335 cmd=35,0,&.,&Enter,&Password
336 cmd=36,0,&.,&Enter,&ASCII message
337 cmd=37,0,&.,&Enter,&Configuration
338 cmd=38,0,&.,&Enter,a new &Room
339 cmd=39,0,&.,&Enter,&Textfile
340 cmd=77,0,&.,&Enter,&Username
341 cmd=40,0,&.,&Enter,file using &Xmodem
342 cmd=42,0,&.,&Enter,file using &Ymodem
343 cmd=44,0,&.,&Enter,file using &Zmodem
345 # Command 57 is the local-file-upload command for users with their own
346 # copy of the clientware. Commands 72-74 are for image uploads.
348 #cmd=57,0,&.,&Enter,&File
349 #cmd=72,0,&.,&Enter,&Image,user &Picture
350 #cmd=73,0,&.,&Enter,&Image,&Room banner
351 #cmd=74,0,&.,&Enter,&Image,&Floor label
353 cmd=41,0,&.,&Enter,re&Gistration
354 cmd=4,0,&.,&Enter,&Message
356 # If you have an external editor defined, it will appear on command 46.
357 cmd=46,0,&.,&Enter,message with &Editor
359 # If you have multiple editors defined, they will appear on
360 # commands 46, 101, 102, 103... up to MAX_EDITORS (5 by default)
361 #cmd=101,0,&.,&Enter,message with &VI
362 #cmd=102,0,&.,&Enter,message with &Nano
364 cmd=59,0,&;,&Configure floor mode
365 cmd=60,0,&;,&Goto floor:
366 cmd=61,0,&;,&Skip to floor:
367 cmd=62,0,&;,&Zap (forget) floor
368 cmd=63,2,&;,&Aide,&Create floor
369 cmd=64,2,&;,&Aide,&Edit this floor
370 cmd=65,2,&;,&Aide,&Kill this floor
371 cmd=68,0,&;,&Known rooms
372 cmd=66,0,&.,&Enter,&Bio
373 cmd=67,0,&.,&Read,&Bio
375 cmd=79,0,&.,&Wholist,&Long
376 cmd=75,0,&.,&Wholist,&Roomname
377 cmd=76,0,&.,&Wholist,&Hostname
378 cmd=91,0,&.,&Wholist,&Active
379 cmd=93,0,&.,&Wholist,&Stealth mode
381 cmd=110,0,&+Next room
382 cmd=111,0,&-Previous room
383 cmd=112,0,&>Next floor
384 cmd=113,0,&<Previous floor
387 # Command 69 allows the user to enter a server command directly. It is
388 # primarily for testing and not intended for general use. Usually there
389 # is no need to enable it.
390 cmd=69,0,&@Server command:
392 # end of command set configuration