User Biography display: remove call, do through templates directly.
[citadel.git] / citadel / citadel.rc
index 667d43c334f60f3faad127ecf6e5f9e330bccb9f..351f5b57c79cfbf92e572ea59821d00200e1dad6 100644 (file)
@@ -1,18 +1,24 @@
 #
-# citadel.rc
-#
 # This file allows full customization of the user interface.
 #
 # 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 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=/usr/local/bin/simped
+# editor=vi
 
 # 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.
@@ -20,23 +26,31 @@ editor=/usr/local/bin/simped
 #printcmd=lpr
 
 # If you define EXPCMD, it will be a pipe through which any incoming
-# express messages will be printed.
-#expcmd=xmessage -title "Express Message" -center -buttons OK -file -
+# instant messages will be printed.
+#expcmd=xmessage -title "Instant message" -center -buttons OK -file -
 
-# 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.
+# ANSI_COLOR should be set to on/off/auto/user to control the use of
+# color on the screen.  If it is set to "auto" then an autodetect will be
+# attempted.  If it is set to "user" then it's a user-configurable option.
 #
-local_screen_dimensions=0
+ansi_color=user
 
-# ANSI_COLOR should be set to "on" "off" or "auto" to control the use of
-# color on the screen.  If it is set to "auto" then an autodetect will be
-# attempted.
+# 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.
 #
-ansi_color=auto
+use_background=off
+
+# STATUS_LINE will keep an informative status line on the top of the screen,
+# but it doesn't work on all terminals (Mac OS is particularly bad at this).
+status_line=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
@@ -61,20 +75,72 @@ use_floors=DEFAULT
 beep=1
 
 # ALLOW_ATTACHMENTS should be set to 1 if you wish the user to be able to
-# attach files to messages.  (Do not enable this for 'safe' public clients.)
-allow_attachments=1
+# attach files to messages and/or save attachments to disk while reading
+# messages.  (DANGER: do NOT enable this for "safe" public clients!)
+#
+allow_attachments=0
 
-# If you set the USERNAME variable, the value you set here will automatically
-# be passed to the "Enter your name:" prompt.
+# 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).
 #
-#username=My User Name
+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,
+# automatically logging in with them on subsequent visits. 
+# (DANGER: do NOT enable this for "safe" public clients!)
+#
+remember_passwords=0
 
-# If you set the PASSWORD variable, the value you set here will automatically
-# be passed to all prompts which request a password ... including the prompt
-# which asks for a password when creating a new user.
+# Optionally, you can force the same username and password everywhere.  This
+# obviously isn't as robust as the password manager.
 #
+#username=My User Name
 #password=mypassword
 
+# If URLCMD is defined, users can hit 'U' after reading a message which
+# contains embedded URL's, and the command will be executed.  Usually this
+# will be used to remote-control a web browser.  (Do not enable this command
+# for 'safe' public clients.)
+#
+# This one ought to work on any Linux that has the "Portland" API's installed.
+# If properly configured, xdg-open will open the URL in the user's preferred
+# web browser.
+#urlcmd=xdg-open "%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 OPENCMD is defined, users can hit 'O' after reading a message which
+# contains attachments, to open the attachments using that command.  This
+# allows attachments to be opened directly from the Citadel client without
+# having to first save them in a file.  The "allow_attachments" option (see
+# above) must be enabled in order for this to work.
+# 
+# xdg-open works on most newer Linux systems
+opencmd=xdg-open "%s"
+#
+# This probably will work on a Macintosh
+#opencmd=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
+
+# xdg-open - on Linux systems with the Portland API's installed, this ought
+# to open the image in the user's preferred viewer.
+#imagecmd=xdg-open "%s"
+#
+# Preview on Mac OS X
+#imagecmd=/Applications/Preview.app/Contents/MacOS/Preview "%s"
+
 
 # COMMAND SET CONFIGURATION
 #
@@ -112,7 +178,6 @@ allow_attachments=1
 #
 cmd=1,0,&? (Help)
 cmd=1,0,&Help
-cmd=2,0,&*Doorway
 cmd=3,0,&Chat
 #
 # If you want to use an external editor by default, set <E>nter message
@@ -131,8 +196,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>
@@ -140,6 +207,7 @@ cmd=19,0,&.,list &Zapped rooms
 cmd=52,0,&.,&Skip ^r^c goto:
 cmd=56,0,&Page a user
 cmd=58,0,&Mail
+cmd=84,0,&Quiet mode
 #
 # We implement both <.G>oto and <J>ump commands which do the same thing, in
 # order to please a wider audience of users.  Remove one if you want to.
@@ -150,22 +218,37 @@ 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
 cmd=70,2,&.,&Aide,&Message edit:
 cmd=78,1,&.,&Aide,&Post
-cmd=80,2,&.,&Aide,&System configuration
+cmd=80,2,&.,&Aide,&System configuration,&General
+cmd=82,2,&.,&Aide,&System configuration,&Internet
+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 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
-cmd=32,0,&.,&Read,&User listing
+
+# The 'read user listing' command accepts two different formats.  The one with
+# the trailing colon allows the user to enter a few characters to search for
+# users with a partial match.
+#
+#cmd=32,0,&.,&Read,&User listing
+cmd=32,0,&.,&Read,&User listing:
+
 cmd=33,0,&.,&Read,&Textfile formatted
 #
 # Command 55 allows the user to save a downloaded file directly to the
@@ -179,9 +262,9 @@ cmd=33,0,&.,&Read,&Textfile formatted
 # dialup use.  They transfer downloaded files to a temporary file and then
 # send them along to a dialup user using the popular protocols.
 #
-cmd=34,0,&.,&Read,file using &Xmodem
-cmd=43,0,&.,&Read,file using &Ymodem
-cmd=45,0,&.,&Read,file using &Zmodem
+cmd=34,0,&.,&Read,file using &Xmodem
+cmd=43,0,&.,&Read,file using &Ymodem
+cmd=45,0,&.,&Read,file using &Zmodem
 cmd=31,0,&.,&Read,&File unformatted
 #
 cmd=13,0,&.,&Read,&New messages
@@ -190,15 +273,17 @@ cmd=71,0,&.,read &Last:
 cmd=9,0,&.,&Read,&Last five msgs
 cmd=14,0,&.,&Read,&Directory
 cmd=49,0,&.,&Read,&Info file
+cmd=114,0,&.,&Read,&Configuration
+cmd=115,0,&.,&Read,&System info
 cmd=35,0,&.,&Enter,&Password
 cmd=36,0,&.,&Enter,&ASCII message
 cmd=37,0,&.,&Enter,&Configuration
 cmd=38,0,&.,&Enter,a new &Room
 cmd=39,0,&.,&Enter,&Textfile
 cmd=77,0,&.,&Enter,&Username
-cmd=40,0,&.,&Enter,file using &Xmodem
-cmd=42,0,&.,&Enter,file using &Ymodem
-cmd=44,0,&.,&Enter,file using &Zmodem
+cmd=40,0,&.,&Enter,file using &Xmodem
+cmd=42,0,&.,&Enter,file using &Ymodem
+cmd=44,0,&.,&Enter,file using &Zmodem
 #
 # Command 57 is the local-file-upload command for users with their own
 # copy of the clientware.  Commands 72-74 are for image uploads.
@@ -210,15 +295,25 @@ cmd=44,0,&.,&Enter,file using &Zmodem
 #
 cmd=41,0,&.,&Enter,re&Gistration
 cmd=4,0,&.,&Enter,&Message
+cmd=127,0,&.,&Enter,remote POP&3 accounts
+cmd=128,0,&.,&Enter,&XML/RSS feed retrieval
+
+# 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=60,0,&.,&Enter,&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
@@ -226,6 +321,28 @@ 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
+
+cmd=110,0,&+Next room
+cmd=111,0,&-Previous room
+cmd=112,0,&>Next floor
+cmd=113,0,&<Previous floor
+cmd=116,0,&.,skip to &+Next room
+cmd=117,0,&.,skip to &-Previous room
+cmd=118,0,&.,skip to &>Next floor
+cmd=119,0,&.,skip to &<Previous floor
+
+cmd=120,0,&.,&Known,&Anonymous rooms
+cmd=121,0,&.,&Known,&Directory rooms
+cmd=68,0,&.,&Known,&Floors
+cmd=49,0,&.,&Known,room &Info
+cmd=122,0,&.,&Known,&Match rooms:
+cmd=123,0,&.,&Known,preferred &Only rooms
+cmd=124,0,&.,&Known,&Private rooms
+cmd=125,0,&.,&Known,&Read only rooms
+cmd=126,0,&.,&Known,&Shared rooms
+cmd=19,0,&.,&Known,&Zapped rooms
 
 #
 # Command 69 allows the user to enter a server command directly.  It is