2 # This file allows full customization of the user interface.
4 # The standard client looks for this file in:
6 # 2. <compiled CTDLDIR>/citadel.rc
8 # 4. <current directory>/citadel.rc
10 # Set ENCRYPT to yes to force SSL/TLS encryption when connecting to a
11 # Citadel server, even if the server is on the same machine as the
12 # client. Set it to no to disable SSL/TLS encryption. The default is to
13 # enable encryption for remote systems and to disable encryption for
14 # systems on the same machine as the client.
17 # Set EDITOR to the name of an external editor to be used for entering
18 # messages. If you want the external editor to be used by default, be sure
19 # to reflect this in the command set below.
23 # If you define PRINTCMD, it will be a pipe through which messages are
24 # printed when the user hits the <P>rint key after a message.
28 # If you define EXPCMD, it will be a pipe through which any incoming
29 # instant messages will be printed.
30 #expcmd=xmessage -title "Instant message" -center -buttons OK -file -
32 # ANSI_COLOR should be set to on/off/auto/user to control the use of
33 # color on the screen. If it is set to "auto" then an autodetect will be
34 # attempted. If it is set to "user" then it's a user-configurable option.
38 # USE_BACKGROUND controls Citadel's use of the background. If it is turned
39 # off, then Citadel will set the background to black. When it is turned on,
40 # the background will be unchanged. This is most useful with "transparent"
41 # terminals. Color must be on (see above) or this option has no effect.
45 # STATUS_LINE will keep an informative status line on the top of the screen,
46 # but it doesn't work on all terminals (Mac OS is particularly bad at this).
49 # PROMPT_CONTROL should be set to on/off/user to control whether the <N>ext
50 # and <S>top keys are active when displaying the paginator prompt. If it
51 # is set to "user" then it's a user-configurable option.
55 # If DISPLAY_MESSAGE_NUMBERS is set to 1, then messages will be displayed
56 # with their message numbers in the header. This is ugly but some
57 # people seem to like it anyway...
59 display_message_numbers=0
61 # The FORCE_MAIL_PROMPTS directive causes mail rooms to always display a
62 # prompt after each message, even if the user has prompts turned off.
66 # USE_FLOORS determines whether the user sees floors, or a flat room space.
67 # Set it to YES to always use floors, NO to never use floors, or DEFAULT
68 # to use the setting in the user's configuration (which is normally the case).
72 # BEEP should be set to 1 if you wish the terminal to beep when an express
73 # message (page) comes in, otherwise set it to 0.
77 # ALLOW_ATTACHMENTS should be set to 1 if you wish the user to be able to
78 # attach files to messages and/or save attachments to disk while reading
79 # messages. (DANGER: do NOT enable this for "safe" public clients!)
83 # IDLE_THRESHOLD is the amount of time a user does nothing before being
84 # listed as "idle" on the who list. The default is 900 seconds (15 minutes).
88 # If you set REMEMBER_PASSWORDS to 1, the Citadel client will offer to
89 # remember your user name and password for every Citadel server you access,
90 # automatically logging in with them on subsequent visits.
91 # (DANGER: do NOT enable this for "safe" public clients!)
95 # Optionally, you can force the same username and password everywhere. This
96 # obviously isn't as robust as the password manager.
98 #username=My User Name
101 # If URLCMD is defined, users can hit 'U' after reading a message which
102 # contains embedded URL's, and the command will be executed. Usually this
103 # will be used to remote-control a web browser. (Do not enable this command
104 # for 'safe' public clients.)
106 # This one ought to work on any Linux that has the "Portland" API's installed.
107 # If properly configured, xdg-open will open the URL in the user's preferred
109 #urlcmd=xdg-open "%s"
111 # This one works really well on a Macintosh -- it opens URL's in whatever
112 # browser you have configured as the system default.
115 # If OPENCMD is defined, users can hit 'O' after reading a message which
116 # contains attachments, to open the attachments using that command. This
117 # allows attachments to be opened directly from the Citadel client without
118 # having to first save them in a file. The "allow_attachments" option (see
119 # above) must be enabled in order for this to work.
121 # xdg-open works on most newer Linux systems
122 opencmd=xdg-open "%s"
124 # This probably will work on a Macintosh
127 # If GOTMAILCMD is defined, the specified command will be executed. This
128 # might be nice for playing sounds or providing any other type of notification.
130 #gotmailcmd=play gotmail.wav
132 # If IMAGECMD is defined, users can hit 'I' to view images attached to a
133 # message. (Do not enable this command for public clients.)
135 # Possible image viewers follow
137 # xdg-open - on Linux systems with the Portland API's installed, this ought
138 # to open the image in the user's preferred viewer.
139 #imagecmd=xdg-open "%s"
141 # Preview on Mac OS X
142 #imagecmd=/Applications/Preview.app/Contents/MacOS/Preview "%s"
145 # COMMAND SET CONFIGURATION
147 # All lines starting with "cmd=" are considered to be commands. This allows
148 # mapping of keytstrokes to various functions of the client.
150 # Format of each line:
151 # cmd_num,access,keystrokes
153 # Keep a copy of the original version of this file around as a reference
154 # for the command numbers. They are not documented anywhere else.
156 # Access is: 0 (all users), 1 (admins or room admins), 2 (admins only).
157 # Please be aware that it is futile to attempt to gain unauthorized access to
158 # the administrative functions of the system by changing all the access levels
159 # to 0. If you do this, you'll simply be able to enter a lot of commands that
160 # will fail at the server ... so don't bother trying. :-)
162 # The actual key to be pressed should be prefaced with an & (ampersand)
163 # character. Ampersands are interesting and useful characters and you should
164 # use them as much as possible. Commands requiring more than one keystroke
165 # should be entered as multiple fields.
167 # If the last keystroke string ends with a : (colon), then the command
168 # will finish by allowing the user to enter a string.
170 # In keystroke names, the string ^r will be replaced by the name of the
171 # current room. The string ^c will be replaced by a comma.
173 # Commands may contain no more than five keystrokes.
175 # Note that the following characters are illegal in commands:
176 # , (comma) : (colon) ^ (caret) & (ampersand)
183 # If you want to use an external editor by default, set <E>nter message
184 # to command #46 (external editor) instead of #4 (built-in editor).
185 cmd=4,0,&Enter message
189 cmd=7,0,&Zap (forget) room
191 cmd=9,0,&Last five msgs
192 cmd=10,0,read &Forward
193 cmd=11,0,read &Reverse
196 cmd=14,0,read &Directory
200 cmd=17,0,&Who is online
201 cmd=47,0,&Abandon ^r^c goto...
202 #cmd=90,0,&Abandon ^r^c goto:
203 cmd=50,0,toggle e&Xpert mode
204 cmd=49,0,read &Info file
206 cmd=19,0,&.,list &Zapped rooms
207 cmd=52,0,&.,&Skip ^r^c goto:
208 cmd=56,0,&Page a user
212 # We implement both <.G>oto and <J>ump commands which do the same thing, in
213 # order to please a wider audience of users. Remove one if you want to.
219 cmd=22,1,&.,&Admin,&Kill this room
220 cmd=23,1,&.,&Admin,&Edit this room
221 cmd=24,0,&.,&Admin,&Who knows room
222 cmd=25,2,&.,&Admin,&User,&Edit
223 cmd=96,2,&.,&Admin,&User,&Delete
224 cmd=26,2,&.,&Admin,&Validate new users
225 cmd=48,1,&.,&Admin,enter &Info file
226 cmd=27,0,&.,&Admin,&Room,&Invite user
227 cmd=28,0,&.,&Admin,&Room,&Kick out user
228 cmd=51,1,&.,&Admin,&File,&Delete
229 cmd=54,1,&.,&Admin,&File,&Move
230 cmd=70,2,&.,&Admin,&Message edit:
231 cmd=78,1,&.,&Admin,&Post
232 cmd=80,2,&.,&Admin,&System configuration,&General
233 cmd=82,2,&.,&Admin,&System configuration,&Internet
234 cmd=88,2,&.,&Admin,&System configuration,&Network
235 cmd=92,2,&.,&Admin,&System configuration,network &Filter list
236 cmd=85,2,&.,&Admin,&Terminate server,&Now
237 cmd=86,2,&.,&Admin,&Terminate server,&Scheduled
238 cmd=87,1,&.,&Admin,mailing &List recipients
239 cmd=94,1,&.,&Admin,mailing list &Digest recipients
240 cmd=89,1,&.,&Admin,&Network room sharing
242 cmd=29,0,&.,&Terminate,and &Quit
243 cmd=30,0,&.,&Terminate,and &Stay online
245 # The 'read user listing' command accepts two different formats. The one with
246 # the trailing colon allows the user to enter a few characters to search for
247 # users with a partial match.
249 #cmd=32,0,&.,&Read,&User listing
250 cmd=32,0,&.,&Read,&User listing:
252 cmd=33,0,&.,&Read,&Textfile formatted
254 # Command 55 allows the user to save a downloaded file directly to the
255 # computer running the client software. It is appropriate for a copy of
256 # this client running on the user's own computer. It is NOT appropriate for
257 # public copies of the client that people will be dialing into.
259 #cmd=55,0,&.,&Read,&File
261 # Commands 34, 43, and 45 are appropriate for public copies of the client for
262 # dialup use. They transfer downloaded files to a temporary file and then
263 # send them along to a dialup user using the popular protocols.
265 # cmd=34,0,&.,&Read,file using &Xmodem
266 # cmd=43,0,&.,&Read,file using &Ymodem
267 # cmd=45,0,&.,&Read,file using &Zmodem
268 cmd=31,0,&.,&Read,&File unformatted
270 cmd=13,0,&.,&Read,&New messages
271 cmd=12,0,&.,&Read,&Old msgs reverse
272 cmd=71,0,&.,read &Last:
273 cmd=9,0,&.,&Read,&Last five msgs
274 cmd=14,0,&.,&Read,&Directory
275 cmd=49,0,&.,&Read,&Info file
276 cmd=114,0,&.,&Read,&Configuration
277 cmd=115,0,&.,&Read,&System info
278 cmd=35,0,&.,&Enter,&Password
279 cmd=36,0,&.,&Enter,&ASCII message
280 cmd=37,0,&.,&Enter,&Configuration
281 cmd=38,0,&.,&Enter,a new &Room
282 cmd=39,0,&.,&Enter,&Textfile
283 cmd=77,0,&.,&Enter,&Username
284 # cmd=40,0,&.,&Enter,file using &Xmodem
285 # cmd=42,0,&.,&Enter,file using &Ymodem
286 # cmd=44,0,&.,&Enter,file using &Zmodem
288 # Command 57 is the local-file-upload command for users with their own
289 # copy of the clientware. Commands 72-74 are for image uploads.
291 #cmd=57,0,&.,&Enter,&File
292 #cmd=72,0,&.,&Enter,&Image,user &Picture
293 #cmd=73,0,&.,&Enter,&Image,&Room banner
294 #cmd=74,0,&.,&Enter,&Image,&Floor label
296 cmd=41,0,&.,&Enter,re&Gistration
297 cmd=4,0,&.,&Enter,&Message
298 cmd=127,0,&.,&Enter,remote POP&3 accounts
299 cmd=128,0,&.,&Enter,&XML/RSS feed retrieval
301 # If you have an external editor defined, it will appear on command 46.
302 cmd=46,0,&.,&Enter,message with &Editor
304 # If you have multiple editors defined, they will appear on
305 # commands 46, 101, 102, 103... up to MAX_EDITORS (5 by default)
306 #cmd=101,0,&.,&Enter,message with &VI
307 #cmd=102,0,&.,&Enter,message with &Nano
309 cmd=59,0,&;,&Configure floor mode
310 cmd=60,0,&;,&Goto floor:
311 cmd=60,0,&.,&Enter,&Floor:
312 cmd=61,0,&;,&Skip to floor:
313 cmd=62,0,&;,&Zap (forget) floor
314 cmd=63,2,&;,&Admin,&Create floor
315 cmd=64,2,&;,&Admin,&Edit this floor
316 cmd=65,2,&;,&Admin,&Kill this floor
317 cmd=68,0,&;,&Known rooms
318 cmd=66,0,&.,&Enter,&Bio
319 cmd=67,0,&.,&Read,&Bio
321 cmd=79,0,&.,&Wholist,&Long
322 cmd=75,0,&.,&Wholist,&Roomname
323 cmd=76,0,&.,&Wholist,&Hostname
324 cmd=91,0,&.,&Wholist,&Active
325 cmd=93,0,&.,&Wholist,&Stealth mode
327 cmd=110,0,&+Next room
328 cmd=111,0,&-Previous room
329 cmd=112,0,&>Next floor
330 cmd=113,0,&<Previous floor
331 cmd=116,0,&.,skip to &+Next room
332 cmd=117,0,&.,skip to &-Previous room
333 cmd=118,0,&.,skip to &>Next floor
334 cmd=119,0,&.,skip to &<Previous floor
336 cmd=120,0,&.,&Known,&Anonymous rooms
337 cmd=121,0,&.,&Known,&Directory rooms
338 cmd=68,0,&.,&Known,&Floors
339 cmd=49,0,&.,&Known,room &Info
340 cmd=122,0,&.,&Known,&Match rooms:
341 cmd=123,0,&.,&Known,preferred &Only rooms
342 cmd=124,0,&.,&Known,&Private rooms
343 cmd=125,0,&.,&Known,&Read only rooms
344 cmd=126,0,&.,&Known,&Shared rooms
345 cmd=19,0,&.,&Known,&Zapped rooms
348 # Command 69 allows the user to enter a server command directly. It is
349 # primarily for testing and not intended for general use. Usually there
350 # is no need to enable it.
351 cmd=69,0,&@Server command:
353 # end of command set configuration