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