# .okbridgerc
# 
# This is an example startup file for the okbridge program.
# When okbridge first starts up, it searches for the .okbridgerc
# startup file.  The current working directory is first searched,
# and if this fails, then the home directory is searched.
#
# Comment lines in the .okbridgerc file begin with a pound sign '#'.
# Noncomment lines contain a keyword and a value associated to that
# keyword.  The possible keyword, value pairs are described below.
#

# efg If this is off, should the old file be read? Should it be deleted?
# AUTOSAVE      ON | OFF
# 	Specifies that we will save the options specified by the user
#	during play of the program to the file .okdefaults after the
#	program terminates.
#
# AUTOSAVE OFF

# BELL		ON | OFF
#	When requesting input (a bid or a play), the terminal's
#	bell is rung by default.  However, this can be disabled
#	by specifying 'BELL OFF'.  This has the same effect as the
#	'/BELL OFF' command.
# BELL OFF

# CCDEF        <card-name> <convention-card>
#      Used to specify a set of named convention cards.  These cards
#      can then be called up using the /SETCC <card-name> command.
#

# The following convention card specifies (most of) the "Class A"
# conventions of the A.C.B.L.  These were taken from _Modern Bridge
# Conventions_ by Root and Pavlicek, and so may be out of date.
#
# If your partnership is not using some of these conventions, then
# prefix the convention name with an exclamation point, i.e., !Unu2N.

# CCDEF SA 5cM 1NT:15-7 Stm Wk2 Blk Ger Ltnr GSF Unu2N StrCue SOS

# The following convention card specifies the conventions found
# on the A.C.B.L. "Yellow Card".  These conventions are IN ADDITION
# to those listed above.

# CCDEF SA-YC SA 5cM Lmt J2N 1NT:15-17 Stm JXF Ger Wk2/RONF Mic/U2N -X:2S SOS

#  DEFAULT         ON | OFF
#       This controls whether or not default inputs will be provided
#       for bids, plays and questions.
#  DEFAULT OFF

# EMAIL        <email-address>
#      This should be your email address.  It is currently used only for
#      identification purposes.
#
# EMAIL mclegg@cs.ucsd.edu

# FULLNAME     <your-full-name>
#      This field is used only for identification purposes, and should
#      contain your full name as you would wish it to be displayed to others.
#
# FULLNAME  Matthew Clegg, University of California

# GPS           ON | OFF
#	Controls whether or not we will contact the Global Player Service
#       automatically when the program starts up.
#
# GPS OFF

# HELPFILE	<directory-name>
#   This field specifies the location of the okbridge help file.
#
# HELPFILE /usr/local/games/okbridge.help

# KEY      <key-name> <key-mapping>
# CNTRL    <key-name> <key-mapping>
# META     <key-name> <key-mapping>
#
#   These fields remap keyboard input.  When a key is pressed, one of
#   three actions may be taken: (1) text is inserted into the input
#   input buffer, (2) a keyboard macro is executed, or (3) a special
#   function is performed.  
#
#   The KEY field can be used to remap any key on the keyboard.
#   The <key-name> should either be a decimal ascii code, or it can be
#   an ascii character if the character is printable.  
#
#   The CNTRL field is used to remap the control keys.  If the
#   <key-name> is a letter (upper or lower case), then the corresponding
#   key is remapped.
#
#   The META key is used to remap meta-keys.  Meta-keys are two-key
#   combinations, where the first key is the meta prefix, and the second
#   key specifies the meta-key.  The default meta-key, as shown below,
#   is control-X.  The <key-name> should either be a decimal ascii code,
#   or it can be an ascii character if the character is printable.
#
#   The <key-mapping> is interpreted as follows.  If the last character
#   of the <key-mapping> is a backslash '\', then the text of the
#   <key-mapping> is inserted into the input buffer when the key is pressed.
#   If the first character of the <key-mapping> is a virgule '/', then
#   the <key-mapping> is interpreted as a command which is executed when
#   the key is pressed.  If the <key-mapping> is the name of one of the special
#   functions listed below, then that function is executed when the key
#   is pressed.  Otherwise, the <key-mapping> is interpreted as a talk message
#   which is sent to the other players when the key is pressed.  To force
#   a <key-mapping> to be a talk message, it may be enclosed in double
#   quotes.
#
#   The current set of special functions are as follows:
#      <CR>       Processes the input buffer.
#      <BS>       Erases the last character in the input buffer.
#      <ERASE>    Erases the entire input buffer.
#      <META>     Interprets the next key as a meta-key.
#      <ESC>      Exits from current activity.
#      <FOCUS>    Rotates the input focus.
#      <REFRESH>  Redraws the screen.
#      <NULL>     Ignores the key.
#
#   Many of the control keys have default mappings.  These mappings
#   are listed below:
#
#       control
#       key       mapping               meaning
#       -------   -------               -------
#       A         /ALERT                Alerts partner's last bid
#       B         /BIDS                 Reviews the bidding
#       D         /DEFAULT TOGGLE       Toggles default input mode
#       E         /EXIT                 Gets out of long displays
#       G         /BELL TOGGLE          Toggles the bell
#       H <BS>    <BS>                  Erases last character typed
#       I <TAB>   <FOCUS>               Rotates the focus buffer
#       J         <CR>                  Causes next line to be entered
#       L         /REVIEW               Reviews the last hand
#       M <CR>    <CR>                  Causes next line to be entered
#       P         /PROMPT TOGGLE        Toggles prompt mode
#       R         <REFRESH>             Refreshes the display
#       T         /TIMER                Updates the timer display
#       U         <ERASE>               Erases the input buffer
#       V         /SPEC                 Go into spectator (view) mode
#       W         /WAKEUP               Sends a wakeup signal to partner
#       X         <META>                Interprets next key as a meta-key
#       <ESC>     <ESC>                 Exits from current prompt
#       <DEL>     <BS>                  Erases last character typed
#
# The following statements swap the Refresh and Review keys:
# CNTRL R /REVIEW
# CNTRL L <REFRESH>
#
# The following are some examples of phrases one might wish to
# bind to meta keys:
# META  b Best of luck, partner!
# META  h Hello!
# META  t Thank you, partner!


 
#   LOG		<filename>  [TEXT|EMAIL|BOTH]
#	If this statement is present in the startup file, then
#	the hands will automatically be logged to the given filename.
#
#       The optional parameter after the filename specifies the format
#       that will be used for recording the hands.  Text specifies
#       a human-readable format, email specifies email duplicate format,
#       and both specifies that two log files will be kept, one in
#       human-readable format and the other in email duplicate format.
# LOG oklog both

# MY_IP        <local-IP-name-number>
#      This field specifies the IP number of the local player.
#      Usually, this okbridge can determine the IP number correctly
#      a call to gethostbyname(), but on some systems, this will
#      not give correct results.
#
# MY_IP         132.239.51.6

#  NAME		<local-player-name>
#	This field specifies the name that will be used to identify
#	the local player to the other players.  It may not have spaces
#	or funny characters in it.
#
# NAME matt

#  PORT		<positive-integer>
#	This field specifies the internet port number that will be
#	used for communications with the server.
#
# PORT 1122

#  PROMPT 	OFF | ON 
#	Usually, the player must press ESC or CR after each trick before
#	seeing the cards played to the next trick.  If 'PROMPT OFF' is
#	specified, then the current trick is cleared and the next trick
#	is displayed as soon as a card is played to the next trick.
# PROMPT OFF

#   REC		<filename>  [TEXT|EMAIL|BOTH]
#	This is similar to the log field in that it opens a file for
#       the recording of hands that are played.  However, a hand is
#       recorded to a REC file only if requested with the /REC command.
# REC okrec both

#  SCOREBOARD   ON | OFF
#       This field determines whether or not the GPS scoreboard will be
#       will be displayed automatically when the program terminates.
# SCOREBOARD OFF

#  SCORE	RUBBER | DUPLICATE | MP | IMP
#	This field is only relevant if the local player is the server.
#	In this case, the SCORING field determines the type of scoring
#	that will be used by default in the game.
# SCORE MP

#  SEAT 	NORTH | EAST | SOUTH | WEST | OBS
#	This field specifies the local player's position.
#
# SEAT north

#  SERVER	ME | <internet-name-or-number>
#	If the value of this field is 'ME', then the local player
#	will assume the role of server.  If the value of this field
#	is anything else, then it is interpreted as an internet name
#	or number of the machine where the server is running.
# SERVER reciprocity

# SETCC           <convention-card>
#      This is a one line description of the conventions which you
#      like to use.   Once you have set your convention card, /SETCC 
#      with no arguments sets your CC to the last CC you set.
#
# SETCC SA 5cM 1NT:15-17 Wk2 Stm Ger RKC !Jac

#  SHOWALERTS ON | OFF
#       This field controls whether or not the player sees alerts made by 
#	partner.  By turning off alerts, you avoid unauthorized information.
#  SHOWALERTS OFF

#  SHOWRESULTS  ON | OFF
#       This field controls whether or not the results of play by other
#       tables are displayed at the end of each duplicate board.
#  SHOWRESULTS OFF

#  TIMER        ON | OFF
#       This controls whether or not the timer will automatically
#       be displayed showing the amount of time spent by the local
#       player and by all players on the current hand.
# 
# TIMER ON

#  ZLOG         <filename>
#       This command is similar to the LOG command, in that it opens
#       a file for recording play, but the format of the file is 
#       different.
# ZLOG okbridge.zlog

