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