]> code.citadel.org Git - citadel.git/blob - citadel/citadel.rc
* Modified <.RU> to allow search for partial match
[citadel.git] / citadel / citadel.rc
1 #
2 # citadel.rc
3 #
4 # This file allows full customization of the user interface.
5 #
6 # The standard client looks for this file in:
7 # 1. $HOME/.citadelrc
8 # 2. /usr/local/lib/citadel.rc
9 # 3. <compiled BBSDIR>/citadel.rc
10 # 4. <current directory>/citadel.rc
11
12 # Set EDITOR to the name of an external editor to be used for entering
13 # messages.  If you want the external editor to be used by default, be sure
14 # to reflect this in the command set below.
15 #
16 editor=vi
17
18 # If you define PRINTCMD, it will be a pipe through which messages are
19 # printed when the user hits the <P>rint key after a message.
20 #
21 #printcmd=lpr
22
23 # If you define EXPCMD, it will be a pipe through which any incoming
24 # express messages will be printed.
25 #expcmd=xmessage -title "Express Message" -center -buttons OK -file -
26
27 # If LOCAL_SCREEN_DIMENSIONS is set to 1, then the screen dimensions will
28 # be requested from the underlying operating system instead of asking the
29 # user.  This works when the user has his/her own copy of the client, it
30 # works for xterms, it sometimes works for telnet sessions, but it doesn't
31 # work for dialup connections.  Generally you should set this to 1 for a
32 # private copy of the client or 0 for a shared copy of the client.
33 #
34 local_screen_dimensions=0
35
36 # ANSI_COLOR should be set to on/off/auto/user to control the use of
37 # color on the screen.  If it is set to "auto" then an autodetect will be
38 # attempted.  If it is set to "user" then it's a user-configurable option.
39 #
40 ansi_color=user
41
42 # If DISPLAY_MESSAGE_NUMBERS is set to 1, then messages will be displayed
43 # with their message numbers in the header.  This is ugly but some
44 # people seem to like it anyway...
45 #
46 display_message_numbers=0
47
48 # The FORCE_MAIL_PROMPTS directive causes mail rooms to always display a
49 # prompt after each message, even if the user has prompts turned off.
50 #
51 force_mail_prompts=1
52
53 # USE_FLOORS determines whether the user sees floors, or a flat room space.
54 # Set it to YES to always use floors, NO to never use floors, or DEFAULT
55 # to use the setting in the user's configuration (which is normally the case).
56 #
57 use_floors=DEFAULT
58
59 # BEEP should be set to 1 if you wish the terminal to beep when an express
60 # message (page) comes in, otherwise set it to 0.
61 #
62 beep=1
63
64 # ALLOW_ATTACHMENTS should be set to 1 if you wish the user to be able to
65 # attach files to messages and/or save attachments to disk while reading
66 # messages.  (DANGER: do NOT enable this for "safe" public clients!)
67 #
68 allow_attachments=0
69
70 # If you set the USERNAME variable, the value you set here will automatically
71 # be passed to the "Enter your name:" prompt.
72 #
73 #username=My User Name
74
75 # If you set the PASSWORD variable, the value you set here will automatically
76 # be passed to all prompts which request a password ... including the prompt
77 # which asks for a password when creating a new user.
78 #
79 #password=mypassword
80
81 # If URLCMD is defined, users can hit 'U' after reading a message which
82 # contains embedded URL's, and the command will be executed.  Usually this
83 # will be used to remote-control a web browser.  (Do not enable this command
84 # for 'safe' public clients.)
85 #
86 #urlcmd=netscape -remote "openURL(%s)"
87
88
89 # COMMAND SET CONFIGURATION
90 #
91 # All lines starting with "cmd=" are considered to be commands.  This allows
92 # mapping of keytstrokes to various functions of the client.
93 #
94 # Format of each line:
95 # cmd_num,access,keystrokes
96 #
97 # Keep a copy of the original version of this file around as a reference
98 # for the command numbers.  They are not documented anywhere else.
99 #
100 # Access is:  0 (all users), 1 (aides or room aides), 2 (aides only).
101 # Please be aware that it is futile to attempt to gain unauthorized access to
102 # the administrative functions of the system by changing all the access levels
103 # to 0.  If you do this, you'll simply be able to enter a lot of commands that
104 # will fail at the server ... so don't bother trying. :-)
105 #
106 # The actual key to be pressed should be prefaced with an & (ampersand)
107 # character.  Ampersands are interesting and useful characters and you should
108 # use them as much as possible.  Commands requiring more than one keystroke
109 # should be entered as multiple fields.
110 #
111 # If the last keystroke string ends with a : (colon), then the command
112 # will finish by allowing the user to enter a string.
113 #
114 # In keystroke names, the string ^r will be replaced by the name of the
115 # current room.  The string ^c will be replaced by a comma.
116 #
117 # Commands may contain no more than five keystrokes.
118 #
119 # Note that the following characters are illegal in commands:
120 #  , (comma)    : (colon)     ^ (caret)     & (ampersand)
121 #
122 #
123 cmd=1,0,&? (Help)
124 cmd=1,0,&Help
125 cmd=2,0,&*Doorway
126 cmd=3,0,&Chat
127 #
128 # If you want to use an external editor by default, set <E>nter message
129 # to command #46 (external editor) instead of #4 (built-in editor).
130 cmd=4,0,&Enter message
131 #
132 cmd=5,0,&Goto
133 cmd=6,0,&Skip ^r
134 cmd=7,0,&Zap (forget) room
135 cmd=8,0,&Known rooms
136 cmd=9,0,&Last five msgs
137 cmd=10,0,read &Forward
138 cmd=11,0,read &Reverse
139 cmd=12,0,read &Old
140 cmd=13,0,read &New
141 cmd=14,0,read &Directory
142 cmd=15,0,&Terminate
143 cmd=16,0,&Ungoto
144 cmd=17,0,&Who is online
145 cmd=47,0,&Abandon ^r^c goto...
146 cmd=50,0,toggle e&Xpert mode
147 cmd=49,0,read &Info file
148 cmd=18,2,&! <shell>
149 cmd=19,0,&.,list &Zapped rooms
150 cmd=52,0,&.,&Skip ^r^c goto:
151 cmd=56,0,&Page a user
152 cmd=58,0,&Mail
153 cmd=84,0,&Quiet mode
154 #
155 # We implement both <.G>oto and <J>ump commands which do the same thing, in
156 # order to please a wider audience of users.  Remove one if you want to.
157 #
158 cmd=20,0,&Jump:
159 cmd=20,0,&.,&Goto:
160 #
161 cmd=21,0,&.,&Help:
162 cmd=22,1,&.,&Aide,&Kill this room
163 cmd=23,1,&.,&Aide,&Edit this room
164 cmd=24,1,&.,&Aide,&Who knows room
165 cmd=25,2,&.,&Aide,edit &User
166 cmd=26,2,&.,&Aide,&Validate new users
167 cmd=48,1,&.,&Aide,enter &Info file
168 cmd=27,1,&.,&Aide,&Room,&Invite user
169 cmd=28,1,&.,&Aide,&Room,&Kick out user
170 cmd=51,1,&.,&Aide,&File,&Delete
171 cmd=53,1,&.,&Aide,&File,&Send over net
172 cmd=54,1,&.,&Aide,&File,&Move
173 cmd=70,2,&.,&Aide,&Message edit:
174 cmd=78,1,&.,&Aide,&Post
175 cmd=80,2,&.,&Aide,&System configuration,&General
176 cmd=82,2,&.,&Aide,&System configuration,&Internet
177 cmd=83,2,&.,&Aide,&System configuration,check &Message base
178
179 cmd=29,0,&.,&Terminate,and &Quit
180 cmd=30,0,&.,&Terminate,and &Stay online
181
182 # The 'read user listing' command accepts two different formats.  The one with
183 # the trailing colon allows the user to enter a few characters to search for
184 # users with a partial match.
185 #
186 cmd=32,0,&.,&Read,&User listing
187 cmd=32,0,&.,&Read,&User listing:
188
189 cmd=33,0,&.,&Read,&Textfile formatted
190 #
191 # Command 55 allows the user to save a downloaded file directly to the
192 # computer running the client software.  It is appropriate for a copy of
193 # this client running on the user's own computer.  It is NOT appropriate for
194 # public copies of the client that people will be dialing into.
195 #
196 #cmd=55,0,&.,&Read,&File
197 #
198 # Commands 34, 43, and 45 are appropriate for public copies of the client for
199 # dialup use.  They transfer downloaded files to a temporary file and then
200 # send them along to a dialup user using the popular protocols.
201 #
202 cmd=34,0,&.,&Read,file using &Xmodem
203 cmd=43,0,&.,&Read,file using &Ymodem
204 cmd=45,0,&.,&Read,file using &Zmodem
205 cmd=31,0,&.,&Read,&File unformatted
206 #
207 cmd=13,0,&.,&Read,&New messages
208 cmd=12,0,&.,&Read,&Old msgs reverse
209 cmd=71,0,&.,read &Last:
210 cmd=9,0,&.,&Read,&Last five msgs
211 cmd=14,0,&.,&Read,&Directory
212 cmd=49,0,&.,&Read,&Info file
213 cmd=35,0,&.,&Enter,&Password
214 cmd=36,0,&.,&Enter,&ASCII message
215 cmd=37,0,&.,&Enter,&Configuration
216 cmd=38,0,&.,&Enter,a new &Room
217 cmd=39,0,&.,&Enter,&Textfile
218 cmd=77,0,&.,&Enter,&Username
219 cmd=40,0,&.,&Enter,file using &Xmodem
220 cmd=42,0,&.,&Enter,file using &Ymodem
221 cmd=44,0,&.,&Enter,file using &Zmodem
222 cmd=81,0,&.,&Enter,IC&Q Configuration
223 #
224 # Command 57 is the local-file-upload command for users with their own
225 # copy of the clientware.  Commands 72-74 are for image uploads.
226 #
227 #cmd=57,0,&.,&Enter,&File
228 #cmd=72,0,&.,&Enter,&Image,user &Picture
229 #cmd=73,0,&.,&Enter,&Image,&Room banner
230 #cmd=74,0,&.,&Enter,&Image,&Floor label
231 #
232 cmd=41,0,&.,&Enter,re&Gistration
233 cmd=4,0,&.,&Enter,&Message
234 cmd=46,0,&.,&Enter,message with &Editor
235 #
236 cmd=59,0,&;,&Configure floor mode
237 cmd=60,0,&;,&Goto floor:
238 cmd=61,0,&;,&Skip to floor:
239 cmd=62,0,&;,&Zap (forget) floor
240 cmd=63,2,&;,&Aide,&Create floor
241 cmd=64,2,&;,&Aide,&Edit floor
242 cmd=65,2,&;,&Aide,&Kill floor
243 cmd=68,0,&;,&Known rooms
244 cmd=66,0,&.,&Enter,&Bio
245 cmd=67,0,&.,&Read,&Bio
246
247 cmd=79,0,&.,&Wholist,&Long
248 cmd=75,0,&.,&Wholist,&Roomname
249 cmd=76,0,&.,&Wholist,&Hostname
250
251 #
252 # Command 69 allows the user to enter a server command directly.  It is
253 # primarily for testing and not intended for general use.  Usually there
254 # is no need to enable it.
255 cmd=69,0,&@Server command:
256 #
257 # end of command set configuration
258 #