]> code.citadel.org Git - citadel.git/blobdiff - citadel/citadel.rc
* Variable names, comments, documentation, etc... removed the acronym 'BBS'
[citadel.git] / citadel / citadel.rc
index 5aa359c736721203467f0d04b2bc68554eb60141..a45dc5405483be3b06d98e630f9c14d3ac821a53 100644 (file)
@@ -5,15 +5,36 @@
 #
 # The standard client looks for this file in:
 # 1. $HOME/.citadelrc
-# 2. /usr/local/lib/citadel.rc
-# 3. <compiled BBSDIR>/citadel.rc
+# 2. <compiled CTDLDIR>/citadel.rc
+# 3. /etc/citadel.rc
 # 4. <current directory>/citadel.rc
 
+# Set ENCRYPT to yes to force SSL/TLS encryption when connecting to a
+# Citadel server, even if the server is on the same machine as the
+# client.  Set it to no to disable SSL/TLS encryption.  The default is to
+# enable encryption for remote systems and to disable encryption for
+# systems on the same machine as the client.
+encrypt=default
+
+# Set FULLSCREEN to yes to (attempt to) use full-screen curses mode.
+# This mode presents a status line and a few other niceties.  Some
+# people might not like this, so you can turn it off here or with the
+# -s command line option.  The default is to use full screen if the
+# terminal supports it.
+fullscreen=no
+
 # Set EDITOR to the name of an external editor to be used for entering
 # messages.  If you want the external editor to be used by default, be sure
 # to reflect this in the command set below.
 #
-editor=pico
+editor=vi
+
+# Or, you could have multiple editors available, like this:
+# ("editor" and "editor0" are the same internally)
+# You can go up to MAX_EDITORS number of editors (5 by default)
+# editor0=pico
+# editor1=vi
+# editor2=nano
 
 # If you define PRINTCMD, it will be a pipe through which messages are
 # printed when the user hits the <P>rint key after a message.
@@ -26,10 +47,10 @@ editor=pico
 
 # If LOCAL_SCREEN_DIMENSIONS is set to 1, then the screen dimensions will
 # be requested from the underlying operating system instead of asking the
-# user.  This works when the user has his/her own copy of the client, it
-# works for xterms, it sometimes works for telnet sessions, but it doesn't
-# work for dialup connections.  Generally you should set this to 1 for a
-# private copy of the client or 0 for a shared copy of the client.
+# user.  On modern networks this is almost always the case: telnet, SSH,
+# xterm, and Unix/Linux consoles all properly report the screen dimensions.
+# Set this option to 0 only if you are running the Citadel client on a
+# direct-dial modem or hardwired terminals.
 #
 local_screen_dimensions=1
 
@@ -39,6 +60,19 @@ local_screen_dimensions=1
 #
 ansi_color=user
 
+# USE_BACKGROUND controls Citadel's use of the background.  If it is turned
+# off, then Citadel will set the background to black.  When it is turned on,
+# the background will be unchanged.  This is most useful with "transparent"
+# terminals.  Color must be on (see above) or this option has no effect.
+#
+use_background=off
+
+# PROMPT_CONTROL should be set to on/off/user to control whether the <N>ext
+# and <S>top keys are active when displaying the paginator prompt.  If it
+# is set to "user" then it's a user-configurable option.
+#
+prompt_control=user
+
 # If DISPLAY_MESSAGE_NUMBERS is set to 1, then messages will be displayed
 # with their message numbers in the header.  This is ugly but some
 # people seem to like it anyway...
@@ -67,6 +101,10 @@ beep=1
 #
 allow_attachments=0
 
+# IDLE_THRESHOLD is the amount of time a user does nothing before being
+# listed as "idle" on the who list.  The default is 900 seconds (15 minutes).
+#
+idle_threshold=900
 
 # If you set REMEMBER_PASSWORDS to 1, the Citadel client will offer to
 # remember your user name and password for every Citadel server you access,
@@ -86,7 +124,75 @@ remember_passwords=0
 # will be used to remote-control a web browser.  (Do not enable this command
 # for 'safe' public clients.)
 #
-#urlcmd=netscape -remote "openURL(%s)"
+# This one works on Linux and most other X11-based Unices.  Specify the full
+# path to Mozilla (or a Mozilla derivative like Netscape) if necessary.
+#urlcmd=mozilla -remote "openURL(%s)"
+#
+# This one works really well on a Macintosh -- it opens URL's in whatever
+# browser you have configured as the system default.
+#urlcmd=open "%s"
+
+# If GOTMAILCMD is defined, the specified command will be executed.  This
+# might be nice for playing sounds or providing any other type of notification.
+#
+#gotmailcmd=play gotmail.wav
+
+# If IMAGECMD is defined, users can hit 'I' to view images attached to a
+# message.  (Do not enable this command for public clients.)
+#
+# Possible image viewers follow
+#
+# XV - This is an oldie but goodie, shareware with source code included, no
+# longer included with some Linux distributions due to licensing.
+#imagecmd=xv "%s"
+
+# The following 2 image viewers are included with KDE:
+# KuickShow has a brightness/gamma option and is simple and ubobtrusive
+#imagecmd=kuickshow "%s"
+
+# KView has no brightness/gamma but can do some minimal cropping and clipboard
+# operations
+#imagecmd=kview "%s"
+
+# Eye of Gnome, the Gnome/Nautilus image viewer component (bare bones
+# view/print):
+#imagecmd=eog "%s"
+
+# GIMP is a free-software attempt at a PhotoShop-like application.
+#imagecmd=gimp "%s"
+
+# Preview on Mac OS X
+#imagecmd=/Applications/Preview.app/Contents/MacOS/Preview "%s"
+
+# MESSAGE READING SEMANTICS (experimental)
+#
+# A new set of message reading semantics is now available.  If you set
+# alternate_semantics, the following changes are made:
+#
+# * Messages are marked as read when you read them, rather than when you
+#   leave the room.  This means read <N>ew will display a new message
+#   at most once, unless last old on new is turned on.
+# * Reading <F>orward or <R>everse does not mark messages as read.
+# * When you leave a room with <G>oto, <J>ump, etc., only messages that
+#   were in the room when you arrived are marked as read.  The original
+#   semantics mark all messages read that were in the room at the time
+#   you leave the room.  This occasionally causes messages to be "lost."
+# * When you leave with <T>erminate, no additional messages are marked
+#   as read.
+# * The <S>kip and <A>bandon commands are reversed.
+#
+# This set of semantics should make Citadel easier to use on very busy
+# systems, where many messages may be posted while reading.  Users
+# accustomed to D.O.C. or its variants will want to set this option.
+#
+alternate_semantics=no
+
+
+# When the user hits the <R>eply key after reading a message, reply_with_editor
+# selects whether it uses the built-in editor (select 'no') or an external
+# editor (select 'yes').
+#
+reply_with_external_editor=no
 
 
 # COMMAND SET CONFIGURATION
@@ -144,8 +250,10 @@ cmd=13,0,read &New
 cmd=14,0,read &Directory
 cmd=15,0,&Terminate
 cmd=16,0,&Ungoto
+cmd=95,0,&.,&Ungoto:
 cmd=17,0,&Who is online
 cmd=47,0,&Abandon ^r^c goto...
+#cmd=90,0,&Abandon ^r^c goto:
 cmd=50,0,toggle e&Xpert mode
 cmd=49,0,read &Info file
 cmd=18,2,&! <shell>
@@ -164,12 +272,13 @@ cmd=20,0,&.,&Goto:
 cmd=21,0,&.,&Help:
 cmd=22,1,&.,&Aide,&Kill this room
 cmd=23,1,&.,&Aide,&Edit this room
-cmd=24,1,&.,&Aide,&Who knows room
-cmd=25,2,&.,&Aide,edit &User
+cmd=24,0,&.,&Aide,&Who knows room
+cmd=25,2,&.,&Aide,&User,&Edit
+cmd=96,2,&.,&Aide,&User,&Delete
 cmd=26,2,&.,&Aide,&Validate new users
 cmd=48,1,&.,&Aide,enter &Info file
-cmd=27,1,&.,&Aide,&Room,&Invite user
-cmd=28,1,&.,&Aide,&Room,&Kick out user
+cmd=27,0,&.,&Aide,&Room,&Invite user
+cmd=28,0,&.,&Aide,&Room,&Kick out user
 cmd=51,1,&.,&Aide,&File,&Delete
 cmd=53,1,&.,&Aide,&File,&Send over net
 cmd=54,1,&.,&Aide,&File,&Move
@@ -179,9 +288,12 @@ cmd=80,2,&.,&Aide,&System configuration,&General
 cmd=82,2,&.,&Aide,&System configuration,&Internet
 cmd=83,2,&.,&Aide,&System configuration,check &Message base
 cmd=88,2,&.,&Aide,&System configuration,&Network
+cmd=92,2,&.,&Aide,&System configuration,network &Filter list
 cmd=85,2,&.,&Aide,&Terminate server,&Now
 cmd=86,2,&.,&Aide,&Terminate server,&Scheduled
-cmd=87,1,&.,&Aide,mailing &List management
+cmd=87,1,&.,&Aide,mailing &List recipients
+cmd=94,1,&.,&Aide,mailing list &Digest recipients
+cmd=89,1,&.,&Aide,&Network room sharing
 
 cmd=29,0,&.,&Terminate,and &Quit
 cmd=30,0,&.,&Terminate,and &Stay online
@@ -191,7 +303,7 @@ cmd=30,0,&.,&Terminate,and &Stay online
 # users with a partial match.
 #
 cmd=32,0,&.,&Read,&User listing
-cmd=32,0,&.,&Read,&User listing:
+#cmd=32,0,&.,&Read,&User listing:
 
 cmd=33,0,&.,&Read,&Textfile formatted
 #
@@ -237,15 +349,22 @@ cmd=44,0,&.,&Enter,file using &Zmodem
 #
 cmd=41,0,&.,&Enter,re&Gistration
 cmd=4,0,&.,&Enter,&Message
+
+# If you have an external editor defined, it will appear on command 46.
 cmd=46,0,&.,&Enter,message with &Editor
-#
+
+# If you have multiple editors defined, they will appear on
+# commands 46, 101, 102, 103... up to MAX_EDITORS (5 by default)
+#cmd=101,0,&.,&Enter,message with &VI
+#cmd=102,0,&.,&Enter,message with &Nano
+
 cmd=59,0,&;,&Configure floor mode
 cmd=60,0,&;,&Goto floor:
 cmd=61,0,&;,&Skip to floor:
 cmd=62,0,&;,&Zap (forget) floor
 cmd=63,2,&;,&Aide,&Create floor
-cmd=64,2,&;,&Aide,&Edit floor
-cmd=65,2,&;,&Aide,&Kill floor
+cmd=64,2,&;,&Aide,&Edit this floor
+cmd=65,2,&;,&Aide,&Kill this floor
 cmd=68,0,&;,&Known rooms
 cmd=66,0,&.,&Enter,&Bio
 cmd=67,0,&.,&Read,&Bio
@@ -253,6 +372,8 @@ cmd=67,0,&.,&Read,&Bio
 cmd=79,0,&.,&Wholist,&Long
 cmd=75,0,&.,&Wholist,&Roomname
 cmd=76,0,&.,&Wholist,&Hostname
+cmd=91,0,&.,&Wholist,&Active
+cmd=93,0,&.,&Wholist,&Stealth mode
 
 #
 # Command 69 allows the user to enter a server command directly.  It is