head	1.28;
access;
symbols;
locks; strict;
comment	@# @;


1.28
date	99.05.07.14.49.30;	author alexis;	state Exp;
branches;
next	1.27;

1.27
date	99.04.28.11.04.37;	author alexis;	state Exp;
branches;
next	1.26;

1.26
date	99.01.07.13.26.17;	author alexis;	state Exp;
branches;
next	1.25;

1.25
date	98.10.21.14.55.16;	author alexis;	state Exp;
branches;
next	1.24;

1.24
date	98.10.17.13.27.51;	author alexis;	state Exp;
branches;
next	1.23;

1.23
date	98.10.07.16.46.12;	author alexis;	state Exp;
branches;
next	1.22;

1.22
date	98.08.28.17.45.15;	author alexis;	state Exp;
branches;
next	1.21;

1.21
date	98.08.28.13.31.20;	author alexis;	state Exp;
branches;
next	1.20;

1.20
date	98.08.28.13.26.59;	author alexis;	state Exp;
branches;
next	;


desc
@PPPLCD CONFIG FILE (PORTED FROM ppplcd.conf.in VER 1.19)
@


1.28
log
@named references changed to wannabe-changed refs.
@
text
@###############################################################################
# 
#  PPPLCD CONFIG FILE (from ppplc release MARKER_PATCHLEVEL)
#
#  READ THIS FILE CAREFULLY! YOU MUST CONFIGURE IT FOR YOUR OWN SITE! IT WILL 
#  NOT WORK WITHOUT CONFIGURING!
#
#  $Header: /diskb/home/alexis/dev/supported/ppplc/doc/examples/RCS/ppplcd.conf.shpp,v 1.27 1999/04/28 11:04:37 alexis Exp alexis $
#
###############################################################################

###############################################################################
#
#  SECTION 1: SERIAL PORT PARAMETERS
#
###############################################################################

#  ID:                 setting-device-modem-device
#  STATUS:             required
#  PURPOSE:            defines modem device
#  SUBSTITUTIONS:      none
#setting-device-modem-device: /dev/ttyS0

#  ID:                 setting-device-modem-speed
#  STATUS:             required
#  PURPOSE:            defines modem speed
#  SUBSTITUTIONS:      none
#setting-device-modem-speed: 115200

##############################################################################
#
#  SECTION 2: MODEM SPECIFICATION
#
##############################################################################

#  ID:                 include
#  STATUS:             at least one 'include' is required in order to
#                      generate the chat script 
#  PURPOSE:            defines script that knows how to control modem
#  SUBSTITUTIONS:      if %T occurs within the included file, then it
#		       is replaced with the telephone number defined elsewhere
#		       in this file

#  SUPPLIED SCRIPT #1: courier-v-everything.conf
#  DESCRIPTION:        supports USR Courier V.Everything modem
#include: MARKER_PRGLIBDIR/modems/courier-v-everything.conf

##############################################################################
#
#  SECTION 3: INTERNET SERVICE PROVIDE SPECIFICATION
#
##############################################################################

#  ID:                 include
#  STATUS:             at least one 'include' is required in order to
#                      generate the chat script 
#  PURPOSE:            defines script that knows how to talk to your ISP
#  SUBSTITUTIONS:      if %L, %P or %I occur within the included file, then 
#                      they will be replaced by the login, password and 
#                      current idle timeout defined elsewhere in this file

#  SUPPLIED SCRIPT #1: demon.conf
#  DESCRIPTION:        provides support for Demon ISP UK
#include: MARKER_PRGLIBDIR/isps/demon.conf

#  SUPPLIED SCRIPT #2: demon-noidle.conf
#  DESCRIPTION:        provides support for Demon ISP UK - without remotely
#                      controlled idle timeouts
#include: MARKER_PRGLIBDIR/isps/demon-noidle.conf

###############################################################################
#
#  SECTION 4: AUTHENTICATION
#
###############################################################################
#
#  This is the phone number, login and password needed by your machine (not
#  you personally) to connect to the Internet. All these parameters are
#  required and have no defaults.
#
###############################################################################

#  What's the ppp connection login?
#setting-connect-login: <put_login_id_here>

#  What's the ppp connection password?
#setting-connect-password: <put_password_here>

#  What's the ppp connection telephone number?
#setting-connect-phonenumber: <put_phonenumber_here>

###############################################################################
#
#  SECTION 5: ACCESS CONTROL 
#
###############################################################################
#
#  By setting the ownership, group and access permissions of an IPC queue, 
#  you can control who can control ppplcd.
#
###############################################################################

#  Who should own the IPC message queue? 'root' is the default. 
#setting-ipc-owner: root

#  What group should own the IPC message queue?  'root' is the default.
#setting-ipc-group: dialout

#  What permissions on the IPC message queue? 0600 is the default.
#setting-ipc-mode: 0660

###############################################################################
#
#  SECTION 6: UNIX COMMAND PATHS
#
###############################################################################
#
#  ppplcd needs to know the location of a few (hopefully) standard Unix
#  commands.
#
###############################################################################

#  What is the full pathname of the 'pppd' command? There is no default.
#command-unix-pppd: /usr/sbin/pppd

#  What is the full pathname of the 'chat' command? There is no default.
#command-unix-chat: /usr/sbin/chat

###############################################################################
#
#  SECTION 7: PPPLCD COMPONENT COMMAND PATHS
#
###############################################################################
#
#  ppplcd calls external programs to perform various tasks, such as 
#  transferring news articles and mail. Example programs to do the tasks
#  are included in the distribution. However how each of tasks is accomplished
#  is very site-specific; you may well have to write your own scripts to
#  do them.
#
###############################################################################

#  ID:                 command-ppplcd-xfer-mail
#  STATUS:             optional
#  PURPOSE:            to transfer mail in both directions
#  CALLED:             immediately after connection up is announced
#  PARAMETERS:         none
#  SUBSTITUTIONS:      none
#  RETURNCODE:         ignored
#
#  SUPPLIED SCRIPT #1: mail-sendmail 
#  DESCRIPTION:        kicks sendmail to send only - sendmail must be already
#                      listening on SMTP port for recieve
#  RETURNCODE:         not set
#
#  SUPPLIED SCRIPT #2: mail-sendmail+fetchmail { all | <user> [ <user> ... ] }
#  DESCRIPTION:        kicks sendmail to send then runs fetchmail 
#  PARAMETERS:         specify users for whom to run fetchmail, or 'all' for all
#  RETURNCODE:         not set

#command-ppplcd-xfer-mail: MARKER_PRGLIBDIR/mail/mail-sendmail
#command-ppplcd-xfer-mail: MARKER_PRGLIBDIR/mail/mail-sendmail+fetchmail

#  ID:                 command-ppplcd-xfer-news
#  STATUS:             optional
#  PURPOSE:            to transfer news in both directions
#  CALLED:             immediately after connection up is announced
#  PARAMETERS:         none
#  SUBSTITUTIONS:      none
#  RETURNCODE:         ignored
#
#  SUPPLIED SCRIPT #1: news-suck { -c | -i }
#  DESCRIPTION:        uses suck to call rpost and lpost to deliver news in
#		       both directions
#  PAREMETERS:         requires -c for C-News and -i FOR INN, note that
#                      only C-News support works currently.
#  RETURNCODE:         not set

#command-ppplcd-xfer-news: MARKER_PRGLIBDIR/news/news-suck -c

#  ID:                 command-ppplcd-misc
#  STATUS:             optional
#  PURPOSE:            to perform miscellaneous commands
#  CALLED:             immediately after connection up is announced
#  PARAMETERS:         none
#  SUBSTITUTIONS:      none
#  RETURNCODE:         ignored
#
#  SUPPLIED SCRIPT #1: misc-null
#  DESCRIPTION:        does nothing, but contains commented out commands to
#                      give you an idea
#  PAREMETERS:         none
#  RETURNCODE:         not set

#command-ppplcd-misc: MARKER_PRGLIBDIR/misc/misc-null

#  The command to test the link quality.
#  If you write your own version of this script, then note it must call 
#  'MARKER_LCLBINDIR/sndmsg 40 <quality-percent>'. If you don't want to
#  do quality checking then disable it later on, not here; you *must* 
#  use this config statement, even if you only set it to '/bin/true'.
#  This script uses ping to assess the link quality, set <remote-ip> to
#  your nearest neighbour on the net.
#command-ppplcd-qualitytest: MARKER_PRGLIBDIR/misc/qtest -v -c 20 <remote-ip>

#  The command to calculate current link use (used to detect idle timeouts).
#  If you write your own version of this script, then note it must call
#  'MARKER_LCLBINDIR/sndmsg 39 <use-count>'. If you don't want to do 
#  idle timeout checking (perhaps the remote end does it), then you must
#  still set this config statement, even if you only set it to '/bin/true'.
#  This script examines /proc/net/dev to assess if the link is in use.
#  Whatever script you use, it is passed one parameter - the name of the
#  ppp interface to examine.
#command-ppplcd-usecount: MARKER_PRGLIBDIR/misc/usecnt -v

#  The command to make link status announcements.
#  If you write your own version of this script, then note it must support
#  the following arguments, with the following meanings:
#   	0: connection has come up
#   	1: link down due to locally detected bad quality - will reconnect
#          automatically in a moment
#   	2: link down due to locally detected bad quality - no reconnection
# 	3: the remote end has hung up for some reason (maybe it detected
#	   bad quality or idle timeout before we did) - will reconnect	
#          automatically in a moment
# 	4: the remote end has hung up for some reason (maybe it detected
#	   bad quality or idle timeout before we did) - no reconnection
#	5: link down due to locally detect idle timeout - will reconnect
#	   in a moment
#	6: link down due to locally detect idle timeout - no reconnection
#       7: the link will go down in 20 minutes
#       8: the link will go down in 5 minutes
#  This script uses wall to make the announcements.
#command-ppplcd-announce: MARKER_PRGLIBDIR/misc/announce -w -b

#  ID:                 command-ppplcd-wannabechanged
#  STATUS:             optional
#  TYPE:               single command string
#  CALLED WHEN:        the 'desire' to be connected changes
#  PASSES ARGS.:       none
#  DOES STR. SUBS.:    none
#  SETS ENV. VARS.:    PPPLCD_WANNABE
#                          0 when connect is no longer wanted
#                          1 when connect is now wanted
#  RC RECIEVED:        ignored
#
#  SUPPLIED SCRIPT #1: MARKER_PRGLIBDIR/misc/nsswitcher
#  DESCRIPTION:        Given /etc/named.boot.local and /etc/named.boot.inet
#                      this script will switch the appropriate DNS config
#                      file in and out as required using a symbolic link.
#  USES ARGS:          none
#  USES ENV. VARS:     PPPLCD_WANNABE
#  OPTIONS:                -v 		verbose
#                          -p <secs>	pause <secs> between stopping and 
#                                       restarting named
#  EXAMPLE:
#command-ppplcd-wannabechanged: MARKER_PRGLIBDIR/misc/nsswitcher -v -p 3

###############################################################################
#
#  SECTION 8: IP SETTINGS
#
###############################################################################
#
#  These values are just passed to pppd. 
#
###############################################################################

#  What netmask does the connection use? 
#setting-ip-netmask: 255.255.0.0

#  What MTU to use? There is a default of 576.
#setting-ip-mtu: 1500

#  What MRU to use? There is a default of 576.
#setting-ip-mru: 1500

##############################################################################
#
#  SECTION 9: MISCELLANEOUS SETTINGS
#
##############################################################################
#
#  This section details config parameters that don't really fit elsewhere.
#
##############################################################################

#  What should the idle timout be (in seconds)?
#setting-misc-timeout-idle: 600

#  If the phone hangs up, do you want automatic reconnection? (0=no, 1=yes)
#setting-misc-autoreconnect: 0

#  What is the minimum acceptable quality (as a percentage) and the interval
#  at which quality checks should be made (in seconds)? Beware of setting
#  the percentage too high; if you set it high and then just one test is
#  below this level then the line will be hung up! Also beware that a low
#  interval may interfere with the idle timeout mechanism! (Use at least
#  1.5 times the timeout period as a minimum).
#setting-misc-quality: 1 900

#  Leave these alone, unless you know what they are!
#setting-pppd-debug: 1
#setting-pppd-kdebug: 7

##############################################################################
@


1.27
log
@removed last remnants of 'newshost' definition
@
text
@d8 1
a8 1
#  $Header: /diskb/home/alexis/dev/supported/ppplc/doc/examples/RCS/ppplcd.conf.shpp,v 1.26 1999/01/07 13:26:17 alexis Exp alexis $
d236 22
a257 14
#  The command to make necessary changes to your host name lookup policy.
#  If it is not defined, then no switching will be done at ip-up time.
#
#  This is typically used to make available the named cache when the ppp
#  connection comes up, and remove it when it is down. It is passed one
#  parameter:
#       0: the ppp connection is down
#       1: the ppp connection is up
#
#  The script that comes with the distribution ('nsswitcher') accepts
#  two options:
#       -v              verbose
#       -p <secs>	pause <secs> betweeen stopping and restarting named
#command-ppplcd-nsswitcher: MARKER_PRGLIBDIR/misc/nsswitcher -v -p 3
@


1.26
log
@symbol name changes
@
text
@d8 1
a8 1
#  $Header: ppplcd.conf.shpp,v 1.25 1998/10/21 14:55:16 alexis Exp alexis $
d169 1
a169 1
#  SUBSTITUTIONS:      %N	newsserver as defined by 'newshost' below
@


1.25
log
@added more new-style comments
@
text
@d3 1
a3 1
#  PPPLCD CONFIG FILE (from ppplc release PATCHLEVEL_MARKER)
d8 1
a8 1
#  $Id: ppplcd.conf.shpp,v 1.24 1998/10/17 13:27:51 alexis Exp alexis $
d46 1
a46 1
#include: PRGLIBDIR_MARKER/modems/courier-v-everything.conf
d64 1
a64 1
#include: PRGLIBDIR_MARKER/isps/demon.conf
d69 1
a69 1
#include: PRGLIBDIR_MARKER/isps/demon-noidle.conf
d161 2
a162 2
#command-ppplcd-xfer-mail: PRGLIBDIR_MARKER/mail/mail-sendmail
#command-ppplcd-xfer-mail: PRGLIBDIR_MARKER/mail/mail-sendmail+fetchmail
d179 1
a179 1
#command-ppplcd-xfer-news: PRGLIBDIR_MARKER/news/news-suck -c
d195 1
a195 1
#command-ppplcd-misc: PRGLIBDIR_MARKER/misc/misc-null
d199 1
a199 1
#  'LCLBINDIR_MARKER/sndmsg 40 <quality-percent>'. If you don't want to
d204 1
a204 1
#command-ppplcd-qualitytest: PRGLIBDIR_MARKER/misc/qtest -v -c 20 <remote-ip>
d208 1
a208 1
#  'LCLBINDIR_MARKER/sndmsg 39 <use-count>'. If you don't want to do 
d214 1
a214 1
#command-ppplcd-usecount: PRGLIBDIR_MARKER/misc/usecnt -v
d234 1
a234 1
#command-ppplcd-announce: PRGLIBDIR_MARKER/misc/announce -w -b
d248 2
a249 2
#       -s <secs>	pause <secs> betweeen stopping and restarting named
#command-ppplcd-nsswitcher: PRGLIBDIR_MARKER/misc/nsswitcher -v -s 3
@


1.24
log
@added more structured comment blocks for a number of commands
@
text
@d8 1
a8 1
#  $Id: ppplcd.conf.shpp,v 1.23 1998/10/07 16:46:12 alexis Exp alexis $
a16 4
#
#  These values are just passed to pppd. 
#
###############################################################################
d18 4
a21 1
#  Where is the modem?
d24 4
a27 1
#  What speed should be connect at?
a34 7
#
#  This section describes how to control your particular model of modem.
#  You need to write a script that initialised the modem and dials a telephone
#  number which you must specify as '%T'. Look at the examples in 
#  PRGLIBDIR_MARKER/modems.
#
##############################################################################
d36 10
a45 1
#  This line provides support for USR Robotics Courier V.Everything.
a52 8
#
#  This section describes how to connect with your particular ISP.
#  You need to write a script that does this. It may use '%L' and '%P' in
#  place of explicit login id and password. And it may make use of '%I',
#  which is replaced by the idle timeout in seconds. Look at the examples
#  in PRGLIBDIR_MARKER/isps.
#
##############################################################################
d54 10
a63 1
#  This line provides support for Demon ISP UK.
d65 4
a68 1
#  This line provides support for Demon ISP UK without remote idle timeout.
@


1.23
log
@changed parameters for usecnt
added nsswitcher onfo
@
text
@d8 1
a8 1
#  $Id: ppplcd.conf.shpp,v 1.22 1998/08/28 17:45:15 alexis Exp alexis $
d135 18
a152 2
#  The command to transfer mail in both directions. 
#  This script is for an SMTP environment using sendmail.
a153 2
#  This script is for an SMTP/POP3 environment using sendmail for sending and
#  fetchmail for retrieving.
d156 15
a170 3
#  The command to transfer news in both directions.
#  This script is for Slurp/CNews and Slurp/INN environments. Use '-c' for
#  CNews or '-i' for INN.
d173 15
a187 5
#  The command to do user-specified connect-time activities.
#  Any additional tasks you might want to perform at connect-time can be
#  put in a script of your own. If you don't want to do anything then set 
#  this to /bin/true.
#command-ppplcd-misc: /bin/true
@


1.22
log
@corrected typos
@
text
@d8 1
a8 1
#  $Id: ppplcd.conf.shpp,v 1.21 1998/08/28 13:31:20 alexis Exp alexis $
d168 3
a170 1
#command-ppplcd-usecount: PRGLIBDIR_MARKER/misc/usecnt -v ppp0
d191 15
@


1.21
log
@minor cosmestic mods, and importantly addition of PATCHLEVEL_MARKER.
@
text
@d8 1
a8 1
#  $Id: ppplcd.conf.shpp,v 1.20 1998/08/28 13:26:59 alexis Exp alexis $
d37 1
a37 1
#  PRGLIBDIR/modems.
d42 1
a42 1
#include: PRGLIBDIR/modems/courier-v-everything.conf
d53 2
a54 1
#  which is replaced by the idle timeout in seconds.
d59 1
a59 1
#include: PRGLIBDIR/isps/demon.conf
d61 1
a61 1
#include: PRGLIBDIR/isps/demon-noidle.cfg
@


1.20
log
@overhauled directive names and reordered.
@
text
@a0 2
# $Id: ppplc.cfg.in,v 1.14 1998/03/01 15:05:13 alexis Exp alexis $

d3 4
a6 1
#  READ THIS FILE CAREFULLY! YOU MUST CONFIGURE IT FOR YOUR OWN SITE!
d8 1
a8 3
#  It is divided into sections, which contain general descriptions and 
#  then specific explanations of each entry. Work through this file slowly
#  and change what's needed.
d191 1
a191 1
#  SECTION 8: IP PARAMETERS
@