suck_040225.shar

Suck Wrappers are a set of UNIX script files that sets up inn, an NNTP server, on a local machine so

#!/bin/sh
# This is a shell archive (produced by GNU sharutils 4.2.1).
# To extract the files from this archive, save it to some FILE, remove
# everything before the `!/bin/sh' line above, then type `sh FILE'.
#
# Made on 2004-02-25 15:33 NZDT by <news@squay>.
# Source directory was `/news/spool/src'.
#
# Existing files will *not* be overwritten unless `-c' is specified.
#
# This shar contains:
# length mode       name
# ------ ---------- ------------------------------------------
#  16623 -r--r--r-- suck/README2
#  11124 -r-xr-xr-- suck/setup_inn.sh
#  20890 -r-xr-xr-- suck/setup_suck.sh
#   8595 -r-xr-xr-- suck/get.news.inn
#   1420 -r--r--r-- suck/suck.conf
#   4626 -r-xr-xr-- suck/put.news.sm
#   1938 -r--r--r-- suck/rpost.sm.conf
#    983 -r--r--r-- suck/put.news.head.conf
#   1395 -r--r--r-- suck/put.news.body.conf
#   6139 -r--r--r-- suck/README
#   3867 -r--r--r-- suck/README3
#   1488 -r-xr-xr-x suck/make_shar.sh
#
save_IFS="${IFS}"
IFS="${IFS}:"
gettext_dir=FAILED
locale_dir=FAILED
first_param="$1"
for dir in $PATH
do
  if test "$gettext_dir" = FAILED && test -f $dir/gettext \
     && ($dir/gettext --version >/dev/null 2>&1)
  then
    set `$dir/gettext --version 2>&1`
    if test "$3" = GNU
    then
      gettext_dir=$dir
    fi
  fi
  if test "$locale_dir" = FAILED && test -f $dir/shar \
     && ($dir/shar --print-text-domain-dir >/dev/null 2>&1)
  then
    locale_dir=`$dir/shar --print-text-domain-dir`
  fi
done
IFS="$save_IFS"
if test "$locale_dir" = FAILED || test "$gettext_dir" = FAILED
then
  echo=echo
else
  TEXTDOMAINDIR=$locale_dir
  export TEXTDOMAINDIR
  TEXTDOMAIN=sharutils
  export TEXTDOMAIN
  echo="$gettext_dir/gettext -s"
fi
if touch -am -t 200112312359.59 $$.touch >/dev/null 2>&1 && test ! -f 200112312359.59 -a -f $$.touch; then
  shar_touch='touch -am -t $1$2$3$4$5$6.$7 "$8"'
elif touch -am 123123592001.59 $$.touch >/dev/null 2>&1 && test ! -f 123123592001.59 -a ! -f 123123592001.5 -a -f $$.touch; then
  shar_touch='touch -am $3$4$5$6$1$2.$7 "$8"'
elif touch -am 1231235901 $$.touch >/dev/null 2>&1 && test ! -f 1231235901 -a -f $$.touch; then
  shar_touch='touch -am $3$4$5$6$2 "$8"'
else
  shar_touch=:
  echo
  $echo 'WARNING: not restoring timestamps.  Consider getting and'
  $echo "installing GNU \`touch', distributed in GNU File Utilities..."
  echo
fi
rm -f 200112312359.59 123123592001.59 123123592001.5 1231235901 $$.touch
#
if mkdir _sh04985; then
  $echo 'x -' 'creating lock directory'
else
  $echo 'failed to create lock directory'
  exit 1
fi
# ============= suck/README2 ==============
if test ! -d 'suck'; then
  $echo 'x -' 'creating directory' 'suck'
  mkdir 'suck'
fi
if test -f 'suck/README2' && test "$first_param" != -c; then
  $echo 'x -' SKIPPING 'suck/README2' '(file already exists)'
else
  $echo 'x -' extracting 'suck/README2' '(text)'
  sed 's/^X//' << 'SHAR_EOF' > 'suck/README2' &&
@(#)README2 Version: 1.1 Date: 04/02/09 13:04:13  Author: PBS
To contact the Author: lmrlnATbigfoot.com replace AT with @
Copyright (C) 2003 Philip Baird Shearer
X
This text is free software; you can redistribute it and/or
modify it under the terms of the GNU General Public License
as published by the Free Software Foundation; either version 2
of the License, or (at your option) any later version.
X
This text  is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.
http://www.gnu.org/copyleft/gpl.html#SEC3
########################################################################
X
X
How to set up suck using setup_suck.sh
########################################################################
CONTENTS
IN A HURRY?
NOW FOR A LONGER EXPLANATION
X	 NTRODUCTION
X	SUCK
X	CUSTOMISATION
X	SETUP
Appendix 1 -- Text of "setup_suck.sh" -Help 
Appendix 2 -- Adding or deleting news groups to the active file
X              How to down load a list of active news groups from your ISP:
X              How to update the active file
########################################################################
IN A HURRY?
X
then run the following commands:
X	su - 
X	su - news
X	suck_yymmdd.shar # where yymmdd is the version of the shar file
X	cd suck
X	setup_inn.sh
X	exit
X	/etc/init.d/innd restart
X	su - news
X	setup_suck.sh
X	cd $HOME
X	suck/get.news.inn
X
You may wish to add a line to the news crontab with the command:
contab -e
X
X	21 2,6,18 * * * /sbin/chkconfig innd && suck/get.news.inn
X
See man crontab(5) for an explanation of the format. This setting
downloads at 21 minutes past the hour 3 times a day at 2am,6am,and 6pm
X
########################################################################
NOW FOR A LONGER EXPLANATION
X
INTRODUCTION
X
This shar ball contains scripts to install a set of wrapper scripts
for suck. They are closely based on the suck distribution sample files.
Two setup scripts are included in the ball which attempt to set up INN
and "suck" to work together to allow "copying news from an NNTP server to
your local machine, and copying replies back up to an NNTP server."
X
* You must have a version of inn on your system owned by the news user
X  who is usually "news". It needs to have been installed correctly but
X  it does not have to be working. The script setup_inn.sh will try to
X  do that.
X
* You must have a working binary of suck installed on your machine and
X  in the path of the news owner. if you do not then go the suck web
X  site and pick up a copy from http://www.sucknews.org. The README file
X  included with this version of the
X
X
See SETUP (below) for how to setup a working suck wrapper environment.
X
get.news.inn		-- main wrapper for "suck" and "rpost"
X	.suckenvrc	-- environment variables, linked to
X			   ~news/.suckenvrc (generated by setup_suck.sh)
X	suck.conf	-- parameters passed to the program suck
X
put.news.sm		-- called by get.news.inn wrapper for "rpost"
X	put.news.body.conf -- "sed -f script-file" stops put.news.sm
X			      from altering the body of a news message.
X	put.news.head.conf -- "sed -f script-file" to alter in the header
X			      of a news message (this may need to be
X			      tailored for your site see "man sed"
X	rpost.conf	-- not used in this version
X	rpost.sm.conf	-- parameters passed to the program rpost
X	
X
setup_inn.sh	-- Setup a basic inn server see section SETUP
setup_suck.sh	-- Setup the suck environment.
X
########################################################################
SUCK
X
Once the suck wrapper environment has been SETUP then the program can
be run from the news user command line with the following command:
X
suck/get.news.inn
X
Please read the suck README file for an explanation of how suck
works. This version of suck is different from the ones in the standard
release in one important way. It uses configuration files instead of
embedding the commands into the scripts. This allows the owner of the
scripts to alter them more easily and succinctly than directly editing
the script files.
X
The configuration files are:
X
X.suckenvrc which is used to hold all environment variables which
X           may need to be customised to run suck programs. It is
X           generated by "setup_suck.sh" and is linked ~/.suckenvrc
X           ~/suck/.suckenvrc. All the environment variables in this file
X           can be altered by setting them in .profile, .bashrc or on the
X           command line before a suck script is run. This is possible
X           because it uses the Bourne shell concept of ${parameter:=word}
X           which means that if the parameter has NOT already been set,
X           then use the string "word". So for example if the suck dir
X           was to be moved from /var/spool/news/suck /news/suck then by
X           setting the variable in ~/.profile "PATHSUCK=/news/suck;export
X           PATHSUCK" this would over ride the setting /var/spool/news/suck
X           in ~/.suckenvrc.
X
suck.conf contains the command line parameters passed to the "suck"
X          program. All of the the variables are set in .suckenvrc with the
X          exception of SUCK_DEBUG which if set to "-D" will cause "suck"
X          to create a debug file called debug.suck in the directory in
X          which the script is run.
X
put.news.body.conf contains part of a sed script executed in the script
X                   put.news.sm. It fixes a bug in the original put.news.sm
X                   script. In the original script any line in the body
X                   which started with the same string as those to be
X                   stripped in the header would be stripped. This sed
X                   script causes the body of the news message to be
X                   passed on to the server without change.
X
put.news.head.conf this sed script strips out header lines from news
X                   postings  not wanted by the ISP server. This script
X                   may need to be altered for use with different ISP
X                   news servers.
X
X
########################################################################
CUSTOMISATION
X
The only script which may need alteration is put.news.head.conf
If you need to stop a header line being uploaded onto the server
add it at the end of the file. The format is "/^sting/d" where 
"^"      is a sed symbol which only match string from the start of a
X         (header) line
"string" should be replaced with the header id to be removed
"d"      is a sed command to delete the line.
X
If you install a new inn system, then it may be necessary to edit the
X.suckenvrc or rerun setup_suck but that is beyond the scope of this
article.
X
########################################################################
SETUP
X
This directory contains a number of files to help set up an inn news
server so that it can download and upload news using the "suck".
X
The two setup files which should be run one after the other are:
i)  setup_inn.sh
ii) setup_suck.sh
X
setup_inn.sh should be run if the innd system has not been set up. This
X             script will do a minimum setup which will allow "suck"
X             to work, but the innd control files probably need further
X             fettling by the news owner. The active file will need to
X             be updated with the required news groups. (See appendix 1)
X             the command line options for setup_inn.sh are:
X
-help        usage: setup_inn.sh {-[Hh]elp|-u[ndo]|domainname}
-undo        will copy saved versions of the files back to their original
X             positions
"domainname" is the name of the local domain. If it is not entered as
X             a command line option it will be requested interactively.
X
The files which are altered by setup_inn.sh are:
in /etc/news:
X		inn.conf newsfeeds readers.conf storage.conf 
X		The originals are stored in the same dir with the
X		extension inn_org.
in /etc/lib/news:
X		if active does not exist: 
X			active
X		if history does not exist:
X			history history.dir  history.hash  history.index 
X			history.n.dir  history.n.hash  history.n.index 
X
setup_suck.sh sets up the suck environment by creating and modifying a
X              number of files. The most important of these are
X              ~/.suckenvrc. The command line options are:
X
-help	usage: setup_suck.sh {-h[elp]|-H[elp_more]|-u[undo]
-Help	more detailed help (see Appendix 1)
X.suckenvrc.nosuck_org
###############################################################################
Appendix 1
X
#############
setup_suck.sh
####
usage: setup_suck.sh {-h[elp]|-H[elp_more]|-u[undo]}
X
This script "setup_suck.sh" sets up a Redhat installation of suck for
your edification and gratification. It assumes that you have already
installed inn and suck using rpm. If you have not set up innd to
your personal setting then please run "setup_inn.sh" before running
"setup_suck.sh". You should be logged in as news.  To do this use
the substitute user program "su" to become root.  Then "su" to news. This
gets around the fact that news does not usually have a password. If you
do not have permission to become root then ask the root user to allow
you access to news by setting a password for news.
su - 		# to substitute as root
su - news	# to substitute as news
X
You can override two of the variables which are created by this script
by setting them at the command line BEFORE running this script:
X  var=sting;export var # where var is the environment variable and string
X                       # is the value
X
The variable which will allow this script to run without having to answer
any in line questions is NNTPSERVER which is your ISP server name eg.
"news.theperfectisp.com"
X
The other variable which can be set before this script is run is:
PATHBIN this is used set the path to the version of
"innconfval". innconfval sets most of the variables used by the inn
system. This script uses some of those variables to set up a resource
file for suck.
X
This script contains a number of hard coded variables at the top of the
script which can be changed manually before it is run.
X   NewsUser=news		# the normal owner of innd
X   Verbose="-v"			# set this to "" for less verbose output
X   SuckEnvRc=.suckenvrc		# the name of the resource file created
X                                # by this script
X   Org=nosuck_org		# backup/recovery (-undo) extension 
X   HostCmd="host -W 120"	# delay command to activate dialup connection
X
The resource file created by this script can be found as a linked file
in two places in the $HOME dir of the innd owner (usually news) and
$HOME/suck. The usual name for this file is .suckenvrc.
X
Files which are altered and are backed up under nosuck_org they are:
X $HOME/suck/$SuckEnvRc (default name .suckenvrc)
X $HOME/suck/$SuckEnvRc as it is linked to $HOME/suck/$SuckEnvRc
X $HOME/suck/active-ignore
X $PATHETC/newsfeeds
X $PATHDB/active
X
If the history file does not exist then one is created. It is
NOT put back in to the original state if the -undo option is run.
To crate the history db the following commands are run:
X   makehistory
X   makedbz -i
X   cp -p $PATHDB/history.n.dir $PATHDB/history.dir
X   cp -p $PATHDB/history.n.hash $PATHDB/history.hash
X   cp -p $PATHDB/history.n.index $PATHDB/history.index
X   makedbz
X
-h[elp] usage
-H[elp] This page
-u[ndo] will move the original contents of the files back
X        into place.
X
#############
setup_inn.sh
####
usage: setup_inn.sh -h[elp]|-H[elp_more]|-u[ndo]|domainname
X
This script "setup_inn.sh" sets up a Redhat inn installation with the
basics that the suck setup script does not.
X
It does this by looking if domain is set in /etc/news/inn.conf
X
If you do not enter a domain name as a command line argument,
you will be asked for it interactively by the scrip. It is
the name of the domain you wish to be in, this is typically
"yousubdomain.ISPdomain".  You will be familiar with it as part
of your email address.	As an example suppose that your ISP gives
you an email address of [e-mail]
then the string needed here is "thesmiths.freeserve.co.uk"
X
If this script gets confused it will ERROR out and you will have to
figure out how to fix the error.
X
This is only a basic setup and it will not be the final one
which you need you MUST RTFM (Read the friendly manual).
The files which are altered are:
X  /etc/news/inn.conf
X  /etc/news/newsfeeds
X  /etc/news/readers.conf
X  /etc/news/storage.conf
X
-h[elp] usage
-H[elp] This page
-u[ndo] will move the original contents of the files back
X        into place.
###############################################################################
Appendix 2
X
How to down load a list of active news groups from your ISP:
------------------------------------------------------------
X	. ~/.suckenvrc 
X	testhost $NNTPSERVER -a  >active.isp
X
See "man testhost" for more details.
X
How to update the active file
-----------------------------
X
Taken From The FAQ
XFrom: INN FAQ Maintainers
Newsgroups: news.software.nntp,news.software.b
Subject: INN FAQ Part 8/9: Appendix A: Norman's install guide
Followup-To: news.software.nntp
Summary: This article is part 8 of a multi-part FAQ: Part 8: Norman's quick guide to getting started (assumes SunOS and other things), and misc. other things.
X
IV. MAINTENANCE OF INN
X
* 1. Adding new groups - see also Part IV, Section 3.b,:
X
a. Type: "ctlinnd pause 'edit active'"
X
b. Edit the active file.  The format is:
X          groupname himark lomark flag.
X
Set himark to 0000000000 and lomark to 0000000001.
X
For detailed description of flags, read the man
X        page for active.  Editing the active file by hand
X        is easy, but will not update the information in
X        that file active.times that some newsreaders