reid@decwrl (Brian Reid) (03/03/86)
#! /bin/sh
# This is a shell archive, meaning:
# 1. Remove everything above the #! /bin/sh line.
# 2. Save the resulting text in a file.
# 3. Unpack the file by typing "sh filename", where "filename" is the
# name of your file. It will create these files in your current
# directory:
# README2
# Makefile.bsd
# Makefile.sysv
# Novice
# Novice.install
# Novice.makefile
# Novice.start
# Novice.step1
# Novice.step2
# Novice.step3a
# Novice.step3b
# cookbook.1.X
# rcbook.t.X
# rcextract.X
# rcindex.X
# rcintro.X
# rckeep.X
# rcnroff.X
# rcshow.X
# rctypeset.X
# recipes.5.X
# configure.sh
# tmac.recip
echo extracting README2
cat > README2 << '13403!mod.recipes!'
This is the distribution of programs that work with mod.recipes files, to make
the USENET cookbook. There is a separate distribution of the documentation.
You should get both distributions before you try to install anything.
If you are not a programmer, but want to use this software, and can't enlist
the help of a programmer, please read the file Novice. It contains simplified
instructions, and can lead you through the installation procedure even if you
have never installed software before.
To install the recipe software at your site, copy either Makefile.bsd or
Makefile.sysv over to be named "Makefile", then edit it per the instructions
in the beginning.
If you have the "less" program, you will probably want to use it instead of
"more". You may find that the best version of troff at your site is called
"ptroff" or "dtroff" or "itroff" or "qtroff" or whatever--the first letter
tends to correspond to the manufacturer of the machine for which that troff
is targeted.
Once you have edited your Makefile, type
make configure
This will produce configured executable versions of the cookbook software in
your current directory. Once you have satisfied yourself that it is not a
trojan horse, type
make install
which will copy the executable programs to the directory you have chosen for
them (we put them in /usr/local/bin) and copy the manual pages to
/usr/man/man1 and /usr/man/man5. You needn't be root to install, you only
need to be a user who has write permission in the bin and man directories.
Once you've done that, go read the man pages, then go play with "rn" and have
fun printing cookbooks. This will also work with readnews; I don't know from
notesfiles, and I have never tried it with vnews or yarn or any of those
other programs.
Here are the program names and what they do:
rcbook.n make a cookbook with nroff
rcbook.t make a cookbook with troff
rcextract extract a recipe from a news article (called by rctypeset)
rcindex produce an index of saved recipes (called by rcbook)
rcintro generate the introduction to the cookbook (called by rcbook)
rckeep keep a recipe
rcnroff run one recipe through nroff
rcshow show one recipe on the screen
rctypeset run one recipe through troff
The troff and nroff macros use the manual macros /usr/lib/tmac/tmac.an as a
subroutine. If your site has changed those manual page macros significantly
from the original AT&T or Berkeley distribution, then things might not work.
In particular, the macros distributed by DEC with Ultrix 1.2 are not
compatible.
Brian Reid
DEC Western Research Laboratory
reid@decwrl.DEC.COM or decwrl!reid
13403!mod.recipes!
echo extracting Makefile.bsd
cat > Makefile.bsd << '13403!mod.recipes!'
# mod.recipes software Makefile. To install, edit the following variables,
# then type "make install"
#
# Where are the object files for the recipe software kept?
OBJDIR=/usr/local/bin
# Where is the news spooling directory?
NEWSDIR=/usr/spool/news
# What is the default "keep" directory. If you want a per-person keep
# directory, put $$HOME/something; if you want a systemwide keep directory
# (to save disk space), then put an absolute pathname here.
DEFDIR=$$HOME/Recipes
# What PATH do you want used inside the shell scripts? At the very least,
# it must contain $OBJDIR
DEFPATH=:$(OBJDIR):/usr/ucb:/usr/bin:/bin:
# What version of TRoff works best at your site, and with what options does it
# do its best job on the Unix manual pages macros?
DEFTROFF=troff -man
# What is your favorite pager and what are its options?
DEFPAGER=more -s
############################################################################
OBJECTS=rcbook.t rcbook.n rcextract rcindex rckeep rcnroff rcshow rctypeset \
rcintro
configure: Makefile
sh configure.sh $(OBJDIR) $(NEWSDIR) '$(DEFDIR)' $(DEFPATH) \
'$(DEFTROFF)' '$(DEFPAGER)'
install:
cp $(OBJECTS) $(OBJDIR)
cp cookbook.1 /usr/man/man1
cp recipes.5 /usr/man/man5
13403!mod.recipes!
echo extracting Makefile.sysv
cat > Makefile.sysv << '13403!mod.recipes!'
# mod.recipes software Makefile. To install, edit the following variables,
# then type "make install"
#
# Where are the object files for the recipe software kept?
OBJDIR=/usr/local/bin
# Where is the news spooling directory?
NEWSDIR=/usr/spool/news
# What is the default "keep" directory. If you want a per-person keep
# directory, put $$HOME/something; if you want a systemwide keep directory
# (to save disk space), then put an absolute pathname here.
DEFDIR=$$HOME/Recipes
# What PATH do you want used inside the shell scripts? At the very least,
# it must contain $OBJDIR
DEFPATH=:$(OBJDIR):/usr/bin:/bin:
# What version of TRoff works best at your site, and with what options does it
# do its best job on the Unix manual pages macros?
DEFTROFF=troff -man
# What is your favorite pager and what are its options?
DEFPAGER=pg
############################################################################
OBJECTS=rcbook.t rcbook.n rcextract rcindex rckeep rcnroff rcshow rctypeset \
rcintro
configure: Makefile
sh configure.sh $(OBJDIR) $(NEWSDIR) '$(DEFDIR)' $(DEFPATH) \
'$(DEFTROFF)' '$(DEFPAGER)'
install:
cp $(OBJECTS) $(OBJDIR)
cp cookbook.1 /usr/man/man1
cp recipes.5 /usr/man/man5
13403!mod.recipes!
echo extracting Novice
cat > Novice << '13403!mod.recipes!'
This file is for people who know how to cook but who don't know how to
program, and who find that they are unable to get the help of a programmer in
getting the mod.recipes software installed.
The novice installation is set up as a series of steps; at the end of each
you will be told what to do next.
To begin, type this command:
Novice.start
Make sure you put the capital N at the beginning of it. If it doesn't work,
try typing this command:
chmod 755 Novice.*
and then try
Novice.start
a second time. If it still doesn't work, then you gotta get help.
13403!mod.recipes!
echo extracting Novice.install
cat > Novice.install << '13403!mod.recipes!'
#! /bin/sh
# This program is part of the novice mod.recipes installation procedure.
# Please read the file "Novice".
trap "rm -f mod.rec.$$" 0 1 2 3 15
echo $$ > mod.rec.$$
if test -f $HOME/mod.rec.$$
then
cat Novice.step3a
else
echo Installing ...
cp $*
cat Novice.step3b
fi
13403!mod.recipes!
echo extracting Novice.makefile
cat > Novice.makefile << '13403!mod.recipes!'
### This file is used as part of the Novice installation procedure. Please
### read file "Novice".
##=
# # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #
# (1) Where is the news spooling directory? If you don't have any idea, then
# leave this line alone--this is the best guess. If you get this wrong,
# all of the programs will still work, though they may give strange error
# messages at times.
NEWSDIR=/usr/spool/news
# (2) What version of troff works best at your site? Change the word "troff"
# to the name of your version, if it is different.
#
# If you don't know, then try one of these guesses:
# If you have an Apple LaserWriter, your best guess is "ptroff"
# If you have an Imagen printer, your best guess is "itroff"
# If you have a QMS or Talaris printer, your best guess is "qtroff"
# Otherwise try just "troff", or ask for help.
# If you get this wrong, you will be able to save recipes but you won't be
# able to typeset them or print them out.
MYTROFF=troff
# (3) What is your favorite pager and what are its options? If you don't have
# any idea, then leave this line alone. If you have a "pg" program, then edit
# the word "cat" into "pg" below. If you have a "more" program, then edit the
# word "cat" into "more". Even if you get this completely wrong, almost
# everything will still work.
DEFPAGER=cat
# # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #
# You should not have to change anything below this line.
DEFTROFF=$(MYTROFF) -man
DEFDIR=$$HOME/Recipes
OBJDIR=$$HOME
DEFPATH=:$(OBJDIR):XXDEFPATH
OBJECTS=rcbook.t rcbook.n rcextract rcindex rckeep rcnroff rcshow rctypeset \
rcintro
configure: Makefile
@sh configure.sh $(OBJDIR) $(NEWSDIR) '$(DEFDIR)' $(DEFPATH) \
'$(DEFTROFF)' '$(DEFPAGER)'
@cat Novice.step2
install:
@Novice.install $(OBJECTS) $(OBJDIR)
13403!mod.recipes!
echo extracting Novice.start
cat > Novice.start << '13403!mod.recipes!'
#! /bin/sh
# This script is used to begin the Novice installation procedure. Please read
# file "Novice" for instructions. Pay no attention to the man behind the
# curtain.
#
###########################################################################
sed -e "s|XXDEFPATH|$PATH|" \
-e "/###/d" \
-e '/##=/a\
# This version of the mod.recipes Makefile is for people who are not really\
# programmers, and who cannot get other help. Edit the file to answer the 3\
# questions below, and then type "make configure".\
' -e '/##=/d' Novice.makefile > Makefile
cat Novice.step1
13403!mod.recipes!
echo extracting Novice.step1
cat > Novice.step1 << '13403!mod.recipes!'
OK, your Makefile is now created. Using your favorite text editor, edit it to
try to answer the 3 questions at the beginning. If you can't answer them,
don't give up--the system will still work to a certain extent without the
answers.
Once you have finished editing the Makefile, type this:
make configure
13403!mod.recipes!
echo extracting Novice.step2
cat > Novice.step2 << '13403!mod.recipes!'
OK, the mod.recipe software and documentation are now all "configured". That
means that they have been updated to reflect the details of your installation.
What you need to do next is to "install" them, which means to copy them to
your home directory where you can execute them while reading news. To do
that, type this:
make install
13403!mod.recipes!
echo extracting Novice.step3a
cat > Novice.step3a << '13403!mod.recipes!'
Because you have been working in your home directory, the software is already
installed there. We're done! Go read the files "cookbook.doc" and
"recipes.doc" for further instructions on how to use mod.recipes (They are
now in your home directory)
-- Brian Reid
13403!mod.recipes!
echo extracting Novice.step3b
cat > Novice.step3b << '13403!mod.recipes!'
You're done. The programs are all installed. Go read the files "cookbook.doc"
and "recipes.doc" for instructions. Happy recipe collecting!
-- Brian Reid
13403!mod.recipes!
echo extracting cookbook.1.X
cat > cookbook.1.X << '13403!mod.recipes!'
.TH COOKBOOK 1 "27 Nov 85" "USENET Cookbook"
.SH NAME
cookbook: rckeep, rcbook.t, rcbook.n, rctypeset, rcnroff \- Store and print the mod.recipes USENET Cookbook
.SH SYNOPSIS
.B rckeep
<
NEWSDIR/mod/recipes/?
(or
.B s\ |rckeep
from a news-reading program.)
.br
.B rcbook.t
to typeset a cookbook from saved recipes
.br
.B rcbook.n
to nroff a cookbook from saved recipes
.SH DESCRIPTION
The USENET Cookbook is an online database distributed in the
.B mod.recipes
newsgroup. This software makes it easy for you to clip recipes that interest
you, to store them in your own directory, and to make printed cookbooks from
those stored recipes.
.SH SAVING RECIPES
.PP
Read the news with your favorite news reading program. If you don't have a
favorite, try
.B rn.
When you see a recipe that interests you, type
.br
.B s |rckeep
.br
The ``s'' command means ``save''; the vertical bar means ``save into a
program''.
.B rckeep
is the program that keeps recipes. It will save recipes into a directory
named Recipes, and it will create that directory for you if it does not
currently exist. If you would like recipes saved in some other place, you can
type
.br
.B s |rckeep PartyRecipes
.br
.B s |rckeep ~/PartyRecipes
.br
.B s |rckeep /usr/local/lib/Recipes
.br
and so forth.
From time to time, an entry will come through in mod.recipes that is labeled
PATCH. This is not a recipe, but an update to a previously-posted recipe. If
you use
.B rckeep
in the regular way, i.e. type
.B s\ |rckeep,
it will apply the
.B patch(1)
program to update your stored copy of the recipe.
.SH HOW RECIPES ARE SAVED
Every recipe is given a code word by the editor of mod.recipes. That code
word is contained in the first few lines of the article body. The
.B rckeep
program uses the code word as a file name in your keep directory. For
example, if you are saving a recipe whose 1-line description is
.br
.B PHEASANT-PERRY - Pheasant for Thanksgiving
.br
it will be saved in your keep directory under the filename ``pheasant-perry''.
These filenames are forced to lower case by
.B rckeep.
.SH MAKING A COOKBOOK
To typeset a cookbook, just type
.br
.B rcbook.t
.br
and all of the recipes in your keep directory will be typeset in alphabetical
order, with an index, introduction, and title page added. If you don't have a
typesetter or if you don't have the
.B troff(1)
program, then use ``\fBrcbook.n\fR'' instead; it uses
.B nroff(1).
.PP
If you have more than one keep directory, for specialty cookbooks of
different types, you can give rcbook a directory name as an argument, e.g.:
.br
.B rcbook.t /usr/local/lib/Recipes
.SH COPYRIGHT
The entire USENET cookbook is copyrighted by the USENET Community Trust. The
purpose of this copyright is to prevent commercial use of the material. The
USENET Community Trust permits any noncommercial use of the contents of the
recipe database, and forbids any commercial use.
.SH FILES
.ta 3i
NEWSDIR/mod/recipes USENET recipe directory
.br
DEFDIR Your keep directory (saved recipes)
.br
OBJDIR/rc* The recipe software
.SH SEE ALSO
recipes(5), rn(1), patch(1),
.SH AUTHOR
Brian K. Reid, DEC Western Research Laboratory
13403!mod.recipes!
echo extracting rcbook.t.X
cat > rcbook.t.X << '13403!mod.recipes!'
#! /bin/sh
# rcbook.t - make a cookbook for the typesetter
#
# Brian Reid, November 1985
# Copyright (C) USENET Community Trust
#
TROFF="DEFTROFF"
PATH=DEFPATH
export PATH
TMAC=/tmp/tmac.$$
INDEX=/tmp/Index.$$
RECIPES=/tmp/Recipes.$$
trap "rm -f $TMAC $INDEX $RECIPES" 0 1 2 3 15
TFLAG=
KEEPDIR=DEFDIR
while [ $# -gt 0 ];
do
case $1 in
-t) TFLAG="$1";;
-*) echo $0: Unknown option $1 1>&2 ; exit;;
"") KEEPDIR=DEFDIR;;
*) KEEPDIR=$1;;
esac
shift
done
if [ ! -d $KEEPDIR ]; then
echo Your keep directory $KEEPDIR does not seem to exist. 1>&2
exit 1
fi;
echo Typesetting cookbook from files in $KEEPDIR 1>&2
cd $KEEPDIR
rcindex -t $KEEPDIR
cat > $TMAC << 'tmac.recip'
TMAC.RECIP
tmac.recip
set `date`
TODAY="$3 $2 $6"
sed -e "s/DATE/$TODAY/" > $INDEX << 'Index'
.RH MOD.RECIPES-SOURCE INDEX Recipes DATE
.ll 6.5i
.nf
.br
.de XX
.tr ~
.ta 2.4iR 2.6i 5.3i
\\$1~~~~~\\$2 \\$3 \\$4 \\$5
..
.so INDEX
Index
rcintro > Introduction
cat [a-z]* > $RECIPES
$TROFF $TFLAG $TMAC Introduction $INDEX $RECIPES
13403!mod.recipes!
echo extracting rcextract.X
cat > rcextract.X << '13403!mod.recipes!'
#! /bin/sh
# rcextract - extract article from mod.recipes
#
# This shell script extracts the portion of a mod.recipes
# article that is supposed to be fed into xroff. It strips off the
# article header and any signature, and sends the resulting text to stdout.
#
# Brian Reid, November 1985
# Copyright (C) 1986, USENET Community Trust
PATH=DEFPATH
export PATH
TMPFILE=/tmp/xart.$$
trap "rm -f $TMPFILE" 0 1 2 3 15
cat > $TMPFILE << 'extractor.awk'
BEGIN {Seen = 0}
/^\.RH MOD\.RECIPES/ {Seen = 1}
/^-- *$/ {Seen = 0}
Seen == 1 {print $0}
extractor.awk
awk -f $TMPFILE
13403!mod.recipes!
echo extracting rcindex.X
cat > rcindex.X << '13403!mod.recipes!'
#! /bin/sh
# rcindex - produce index of recipes
#
# usage:
# rcindex [ -options ] [ keepdir ]
#
# This shell script produces an index of all recipes in a keep directory.
# That index is an nroff/troff document that will be used as a part
# of the book produced from that directory.
#
# If you don't specify a keep directory, it will use DEFDIR, which
# is as good a place as any.
#
# Brian Reid, November 1985
# Copyright (C) 1986, USENET Community Trust
#
PATH=DEFPATH
export PATH
case $1 in
-*) OPTIONS=$1; shift;;
*) OPTIONS=;;
esac
case $1 in
"") KEEPDIR=DEFDIR;;
*) KEEPDIR=$1;;
esac
if [ ! -d $KEEPDIR ]; then
echo Your keep directory $KEEPDIR does not seem to exist.
exit 1
fi;
cd $KEEPDIR
grep \^.RZ [a-z]* |\
sed -e 's/\: *.RZ //' |\
awk -F\" '{print $1,$4}' |\
ptx -f -r $OPTIONS |\
sed -e 's/^\.xx/.XX/' > INDEX
13403!mod.recipes!
echo extracting rcintro.X
cat > rcintro.X << '13403!mod.recipes!'
#! /bin/sh
# Copyright (C) 1986, USENET Community Trust
#
cat << 'YumYumEatemup'
.RH MOD.RECIPES-SOURCE INTRODUCTION M "23 Jan 1986" 1986
.SH "\s16THE USENET COOKBOOK\s10"
USENET is the Unix community's communication network. It is used
for communicating information among Unix computer sites
worldwide. The USENET Cookbook is a collection of recipes that were
contributed by USENET members, transmitted electronically to the editor
in California, and then published via USENET.
.PP
.ie t \{The USENET Cookbook is a database and not just a book.
The paper copy that you
are holding was printed from a copy of the online database at some USENET
site, but even as you are reading it, new recipes are being added to that
database. \}
.el \{The USENET Cookbook is an online database distributed with the
intention that it be published as a book. \}
The USENET Cookbook is distributed with software that enables every user to
make his own personal customized edition of it, leaving out the recipes that
he has no interest in, and perhaps adding a few of his own that he hasn't
yet submitted to the network. There will be many different versions and
editions of it, all with the same title, and all copyrighted.
.SH DISTRIBUTION
The USENET cookbook is distributed in the newsgroup named ``mod.recipes''.
You will need to get that newsgroup at your site.
A package of software for dealing with mod.recipes, including troff macros,
extraction programs, indexing programs, and this introduction, is posted from
time to time into mod.recipes and net.sources. Get that software and install
it on your machine.
.SH PROCEDURE
To submit a recipe to the USENET cookbook, just mail its text to the
newsgroup moderator, glacier!mod-recipes by uucp or
mod-recipes@glacier by internet. The netnews software on most
machines will do this automatically if you try to post to mod.recipes
.PP
You can also submit evaluations, modifications, suggestions, or bug-fixes to
existing recipes.
.SH THE EDITOR
The editor of the USENET Cookbook is Brian Reid, of DEC Western Research
Laboratory. Like the editor of any publication, he did not do a majority of
the writing. He has contributed a few of his own recipes, but his
contribution is primarily that he organized the cookbook venture, that he
wrote the software that publishes the cookbook from the online database, and
he edits and takes final responsibility for the appearance and content of
recipes that are put into the database.
.SH NOTES
It's important that you tell us where you got the recipe from. It's ok if you
cribbed it from a book or magazine or newspaper, but if you copy the
words that you found there, you have probably violated a copyright.
.PP
While the main purpose of the USENET cookbook is to let us all make our own
custom cookbooks, we can't ignore the reality of the copyright law. Surely
you have noticed that every modern book says ``\fINo part of this publication
may be reproduced, stored in a retrieval system, or transmitted, in any form
or by any means, electronic, ..., or otherwise without the prior written
permission of the publisher.\fR''
.PP
Copyright law is complex, and only a lawyer
can reliably advise you on whether or not you are violating it, but in
general if you rewrite a recipe, in your own words, even if you don't change
the recipe, then you are not infringing the copyright by submitting that
recipe to the network. The copyright is on the words that explain the recipe,
and not the recipe itself.
.SH COPYRIGHT
The entire USENET Cookbook is Copyrighted by the USENET Community Trust. The
purpose of this copyright is to prevent commercialization or profit-making
use of the Cookbook. As a user of USENET you are explicitly granted
permission to make copies of this material, provided that you don't remove
the copyright notice or the USENET Cookbook label.
.WR
Brian Reid, decwrl!reid, reid@decwrl
DEC Western Research Laboratory, Palo Alto CA
'YumYumEatemup'
13403!mod.recipes!
echo extracting rckeep.X
cat > rckeep.X << '13403!mod.recipes!'
#! /bin/sh
# rckeep - keep a recipe by adding it to a keep directory
#
# usage:
# rckeep [ keepdir ] [ filename ]
#
# This program lets you snatch recipes out of newsgroups and store them in
# a "keep" directory. They are stored in a file name that matches the
# recipe id, which is found in the .RH command in the recipe.
#
# If you don't specify a keep directory, it will use DEFDIR which
# is as good a place as any. You can use ~/ to stand for $HOME/ if you want.
#
# Brian Reid, November 1985
# Copyright (C) 1986, USENET Community Trust
#
PATH=DEFPATH
export PATH
TEMPFILE=/tmp/rckeep.$$
case $1 in
"") KEEPDIR=DEFDIR;;
~/*) KEEPDIR=$HOME/`expr $1 : '~/\(.*\)'`;;
~*) echo Sorry, I cannot process ~ notation, except for ~/...;
exit 1;;
*) KEEPDIR=$1;;
esac
if [ ! -d $KEEPDIR ]; then
echo Creating new keep directory $KEEPDIR;
mkdir $KEEPDIR;
fi;
case $2 in
"") rcextract > $TEMPFILE;;
*) rcextract < $2 > $TEMPFILE;;
esac
# the [A-Z] in tr arg below is for compatibility with SysV
IDLINE=`awk '{print $2,$3; exit;}' < $TEMPFILE | tr "[A-Z]" "[a-z]" `
case $IDLINE in
"") echo This is not a mod.recipes datafile. I do not know what to do with it.
exit 1;;
esac
set $IDLINE
KEEPNAME=$2
FILETYPE=$1
case $FILETYPE in
mod.recipes-source) if [ -f $KEEPDIR/$KEEPNAME ]; then
echo Overwriting previous version of `basename $KEEPNAME`
fi
mv $TEMPFILE $KEEPDIR/$KEEPNAME
echo Saved as $KEEPDIR/$KEEPNAME;;
mod.recipes-patch) if [ -f $KEEPDIR/$KEEPNAME ]; then
echo Updating old version of $KEEPNAME
patch -s $KEEPDIR/$KEEPNAME < $TEMPFILE
else
echo Sorry, but the recipe $KEEPNAME is not there. I cannot patch it.
fi;;
*) echo This is not a mod.recipes datafile. I do not know what to do with it.;
exit 1;;
esac
13403!mod.recipes!
echo extracting rcnroff.X
cat > rcnroff.X << '13403!mod.recipes!'
#! /bin/sh
# rcnroff - nroff a recipe
#
# This shell script extracts a recipe from a mod.recipes netnews article and
# nroffs that recipe to the standard output.
#
# Brian Reid, November 1985
#
TROFF="nroff -man"
PATH=DEFPATH
export PATH
TMPFILE=/tmp/xart.$$
TMAC=/tmp/tmac.$$
trap "rm -f $TMPFILE $TMAC" 0 1 2 3 15
cat > $TMPFILE << 'extractor.awk'
BEGIN {Seen = 0}
/^\.RH MOD\.RECIPES/ {Seen = 1}
/^-- *$/ {Seen = 0}
Seen == 1 {print $0}
extractor.awk
cat > $TMAC << 'tmac.recip'
TMAC.RECIP
tmac.recip
awk -f $TMPFILE |\
$TROFF $TMAC -
13403!mod.recipes!
echo extracting rcshow.X
cat > rcshow.X << '13403!mod.recipes!'
#! /bin/sh
# rcshow - show a recipe
#
# This shell script extracts a recipe from a mod.recipes netnews article and
# nroffs it for display on the screen. This differs slightly from "nrecipe"
# in that it is not page-oriented. Actually, this program is almost too slow
# to use, because it has to run nroff every time.
#
# Brian Reid, November 1985
# Copyright (C) 1986, USENET Community Trust
#
# If you don't have "less", you will want to
# add "ul" to the pipeline to get the underlines right.
TROFF="nroff -man"
PAGER="DEFPAGER"
PATH=DEFPATH
export PATH
TMPFILE=/tmp/xart.$$
TMAC=/tmp/tmac.$$
trap "rm -f $TMPFILE $TMAC" 0 1 2 3 15
cat > $TMPFILE << 'extractor.awk'
BEGIN {Seen = 0}
/^\.RH MOD\.RECIPES/ {Seen = 1}
/^-- *$/ {Seen = 0}
Seen == 1 {print $0}
extractor.awk
cat > $TMAC << 'tmac.recip'
TMAC.RECIP
tmac.recip
awk -f $TMPFILE |\
$TROFF $TMAC - | $PAGER
# if you don't have "less", you will probably want to change the above line
# into $TROFF $TMAC - | ul | $PAGER
13403!mod.recipes!
echo extracting rctypeset.X
cat > rctypeset.X << '13403!mod.recipes!'
#! /bin/sh
# rctypeset - typeset a recipe
#
# This shell script extracts a recipe from a mod.recipes netnews article and
# typesets it with troff. TRoff sends directly to the typesetter; if you
# don't have a typesetter, or have more than one, please consult your site
# administrators to find out what to do.
#
# Brian Reid, November 1985
# Copyright (C) 1986, USENET Community Trust
#
TROFF="DEFTROFF"
PATH=DEFPATH
export PATH
TMPFILE=/tmp/xart.$$
TMAC=/tmp/tmac.$$
trap "rm -f $TMPFILE $TMAC" 0 1 2 3 15
cat > $TMPFILE << 'extractor.awk'
BEGIN {Seen = 0}
/^\.RH MOD\.RECIPES/ {Seen = 1}
/^-- *$/ {Seen = 0}
Seen == 1 {print $0}
extractor.awk
cat > $TMAC << 'tmac.recip'
TMAC.RECIP
tmac.recip
awk -f $TMPFILE |\
$TROFF $TMAC -
13403!mod.recipes!
echo extracting recipes.5.X
cat > recipes.5.X << '13403!mod.recipes!'
.TH RECIPES 5 "27 Nov 85" "USENET Cookbook"
.SH NAME
recipes \- USENET Cookbook (mod.recipes) format and submitting procedure.
.SH SYNOPSIS
Mail your recipe to mod-recipes@glacier. Try not to plagiarize.
If you want to put in your own troff commands, use the Unix manual macros.
.SH DESCRIPTION
Mod.recipes is a ``moderated newsgroup''. This means that you mail your
submissions to the moderator, and he distributes them.
The moderator's mailbox is
.br
glacier!mod-recipes,
.br
if you believe in that kind of address, or
.br
{hplabs, decwrl, bellcore, pyramid, sun}!glacier!mod-recipes
.br
if you believe in the other kind of address. The addresses
.br
mod-recipes@SU-Glacier.ARPA
and mod-recipes@Glacier.STANFORD.EDU
.br
also work, if you know how to mail to them.
.PP
If your netnews administrator has set things up properly and if you are
running the right news software, you can just post to mod.recipes as you
would any other group, but your posting will be mailed to the moderator
insted of being placed directly in the newsgroup.
.SH HOW TO STRUCTURE A RECIPE
Every recipe that goes out will be formatted with a small set of troff
commands. If you don't know any troff, then just send the text of your
recipe. If you can do the formatting yourself, then great! That will save
the editor a lot of time. Some hints for how to do it are in a later section
of this documentation.
If you don't know about xroff/troff/nroff but you do want to be helpful,
then you can help a lot by doing this:
.PP
.IP 1 5
Put your recipe in the standard sequence:
.RS 10
- Title and 1-line description
.br
- Introductory commentary, explaining (if possible) where you got
the recipe from.
.br
- list of ingredients, using "Tbsp.", "tsp.", "cup", "oz", and "lb",
.br
- Numbered sequence of recipe steps.
.br
- Notes (if any). Comments on how you like to make it, or ingredient
availability, etc.
.br
Your ``signature''. This should include your name and net address, the
organization that you are a part of, and the name of the city it is in. It can
also include other frivolity or foolishness if you like; I'll include as
much of it as will fit on the page.
.RE
.IP 2 5
Don't put any tab characters (^I) in the file if you can possibly avoid it.
They do strange things on typesetters.
.IP 3 5
If you are a troff wizard, please don't use any of that wizardry in these
recipes. If you stick to the set of commands used in the Unix manual macros
(see \fIman(7)\fR), and the set of commands that are part of the USENET
Cookbook package (see following section), then things should work.
.RE
.PP
You can also submit evaluations, modifications, suggestions, or bug-fixes to
existing recipes.
.SH COPYRIGHT NOTES
It's important that you tell us where you got the recipe from. It's ok if you
cribbed it from a book or magazine or newspaper, but if you copy exactly the
words that you found there, there might be a problem with copyright violation.
.PP
While the main purpose of the USENET cookbook is to let us all make our own
custom cookbooks, we can't ignore the reality of the copyright law. Surely
you have noticed that every modern book says ``\fINo part of this publication
may be reproduced, stored in a retrieval system, or transmitted, in any form
or by any means, electronic, ..., or otherwise without the prior written
permission of the publisher.\fR''
.PP
Copyright law is complex, and only a lawyer
can reliably advise you on whether or not you are violating it, but in
general if you rewrite a recipe, in your own words, even if you don't change
the recipe, then you are not infringing the copyright by submitting that
recipe to the network. The copyright is on the words that explain the recipe,
and not the recipe itself.
.PP
The USENET Cookbook itself is copyrighted. Every recipe is sent out with a
copyright notice, and the macros that print the cookbooks add a copyright
notice to the bottom of each page. The purpose of this is to prevent
commercial use of the USENET Cookbook.
.SH DO YOUR OWN FORMATTING
If you put formatting commands in the recipes that you submit, they will go
out more quickly, since the editor won't have to do it.
It's easy to learn how.
.PP
The basic principle is to use as few commands as possible, and in general to
use only commands that are defined in the manual macros or the recipe macro
package. Various processing programs search through these files and look for
string matches on things like ".IG" and ".RZ".
Print out a few of the recipe source files from NEWSDIR/mod/recipes,
and then use OBJDIR/rctypeset
or OBJDIR/rcnroff to produce
formatted versions of them. Have that at hand when you are formatting
your recipe. You can test your formatting by using rctypeset or rcnroff on
your draft versions before you submit the recipe.
.PP
A ``skeleton'' recipe follows. .RH is the recipe header command; it must be
the first line of each recipe and it must have 4 arguments.
"RECIPE-ID" is the file name under which the recipe will be stored; it must
be 14 characters or less. The "?" is a "what kind of recipe" code from the
code table below.
.nf
.ta 3i
.RS 4
\&.RH MOD.RECIPES-SOURCE RECIPE-ID ? "22 Dec 83"
\&.RZ "RECIPE TITLE" "One-line description of it"
Introductory comments; use .PP for new paragraph.
\&.IH "Serves 13" <-- Ingredients Header
\&.IG "1/2 cup" "butter" <-- Ingredient (please use quotes)
\&.IG "1" "onion"
(medium to large, chopped fine. Don't try to use instant onion
in this recipe)
\&.PH <-- Procedure header
\&.SK 1 <-- Procedure step
Preheat oven to 600 degrees <-- Text for that step
\&.SK 2 <-- and so forth.
\&.NX <-- Notes header
Notes (commentary) goes here; use .PP to separate paragraphs.
\&.WR <-- Wrapup
Signature information goes here. As a minimum you should list your name,
network address, organization (company, university, etc.), and the city you
live or work in.
.RE 4
.fi
Remember that when you post to a moderated newsgroup, the news software
usually forgets to include your .signature file, so you should be sure to
include it manually. If it manages to get there twice, I will remove the
extra copy.
.PP
You can also use the following -man macros; see \fIman(7)\fR for the complete
list.
.nf
.RS 4
.ta 3i
\&.I "italic words"
\&.B "boldface words"
\&.SM "small words"
\&.PP <-- paragraph break
\&.PD <distance> <-- paragraph distance
\&.IP "indented paragraph".
\&.RS <-- relative start: move things to the right
\&.RE <-- relative end: move things left again
.RE 4
.fi
You can also use these nroff/troff commands:
\\fI,
\\fB,
\\fR,
\&.if,
\&.ds,
\&.br,
\&.nf,
\&.fi,
and .ta,
.SH CATEGORY CODES
.nf
.ta .4i 1i 3i 3.6i
M Main dish SL Salad
A Appetizer or snack SP Soup
B Bread/cake/pasta D Dessert
L Beverage (Liquid) V Vegetable dish
.fi
The suffix ``V'' on any category means that it is vegetarian; for example, a
vegetarian main dish recipe would be marked ``MV''.
.SH SEE ALSO
cookbook(1), rn(1)
.SH AUTHOR
Brian Reid is the organizer of mod.recipes, the editor of the USENET
Cookbook, and the author of most of the software.
13403!mod.recipes!
echo extracting configure.sh
cat > configure.sh << '13403!mod.recipes!'
#! /bin/sh
# Script to configure and install the other shell scripts for mod.recipes.
# Brian Reid, December 1985
#
OBJDIR="$1"
NEWSDIR="$2"
DEFDIR="$3"
DEFPATH="$4"
DEFTROFF="$5"
DEFPAGER="$6"
# make rcbook.n.X from rcbook.t.X
sed -e "s+DEFTROFF+nroff -man+" \
-e "s+for the typesetter+with nroff+" \
-e "s+Typesetting+Formatting+" \
-e "/^rcindex/s+ -t++" \
-e '/^\$TROFF/s+$+ > Cookbook.nr+' \
-e '/^\$TROFF/a\
echo Cookbook.nr created 1>&2' \
< rcbook.t.X > rcbook.n.X
# now configure the executable programs
for i in *.X
do
j=`basename $i .X`
echo Processing $i into $j
sed -e "s+OBJDIR+$OBJDIR+" \
-e "s+NEWSDIR+$NEWSDIR+" \
-e "s+DEFDIR+$DEFDIR+" \
-e "s+DEFPATH+$DEFPATH+" \
-e "s+DEFPAGER+$DEFPAGER+" \
-e '/^TMAC.RECIP$/r tmac.recip' \
-e '/^TMAC.RECIP$/d' \
-e "s+DEFTROFF+$DEFTROFF+" < $i > $j
chmod 755 $j
done
13403!mod.recipes!
echo extracting tmac.recip
cat > tmac.recip << '13403!mod.recipes!'
.\" Macro package Copyright (C) 1986 USENET Community Trust
.\"
' # Recipe Heading
.de RH
.ie '\\$5'' .ds YR 1985
.el .ds YR \\$5
.ds YC Copyright \(co \\*(YR USENET Community Trust
.TH \\$2 "\\$3" "\\*(YC" "mod.recipes \\$4" "USENET Cookbook"
.ds ]H \\$2
..
.de RZ
.SH \\s14\\$1
\\*(]H \- \\$2
.PP
..
' # Ingredient
.de IG
.TP 10
\&\\$1
.I \\$2
..
' # Step
.de SK
.IP "(\\$1)" 5n
..
' # Ingredient header
.de IH
.SH INGREDIENTS (\\$1)
.PD 0
..
' # Procedure header
.de PH
.PD
.ie '\\$1'' .SH PROCEDURE
.el .SH PROCEDURE \\$1
.RS 5
..
' # Notes
.de NX
.PD
.SH NOTES
..
' # Wrapup
.de WR
.RE 5
.PD
.SH CONTRIBUTOR
.nf
..
.\" these macros courtesy of Bernie Cosell and Matt Bishop
.de CS \" do the fancy "go into cs mode right" guy
. ie \\n(.z .cs \\$1 \\$2 \\$3
. el \!.CS \\$1 \\$2 \\$3
..
.
.de FW \" Go into fixed-width mode: put both italic and bold fonts in it
. CS B 21 \\(.s
. CS I 21 \\(.s
. ss 24
. lg 0
..
.
.de Fw \" Leave fixed-width mode
. CS B
. CS I
. ss 12
. lg 1
..
13403!mod.recipes!recipes@decwrl.UUCP (05/29/86)
#! /bin/sh
# This is a shell archive, meaning:
# 1. Remove everything above the #! /bin/sh line.
# 2. Save the resulting text in a file.
# 3. Unpack the file by typing "sh filename", where "filename" is the
# name of your file. It will create these files in your current
# directory:
# README2
# Makefile.bsd
# Makefile.sysv
# Novice
# Novice.install
# Novice.makefile
# Novice.start
# Novice.step1
# Novice.step2
# Novice.step3a
# Novice.step3b
# cookbook.1.X
# rcbook.t.X
# rcextract.X
# rcindex.X
# rcintro.X
# rckeep.X
# rckeepnew.X
# rcnew.t.X
# rcnroff.X
# rcshow.X
# rctypeset.X
# recipes.5.X
# configure.sh
# tmac.recip
echo extracting README2
cat > README2 << '8765!mod.recipes!'
This is the distribution of programs that work with mod.recipes files, to make
the USENET cookbook. There is a separate distribution of the documentation.
The man pages that are part of this distribution contain all of the
information that is present in the documentation distribution, but if you
get that distribution you can read the documentation before you install
anything.
If you are not a programmer, but want to use this software, and can't enlist
the help of a programmer, please read the file Novice. It contains simplified
instructions, and can lead you through the installation procedure even if you
have never installed software before.
To install the recipe software at your site, copy either Makefile.bsd or
Makefile.sysv over to be named "Makefile", then edit it per the instructions
in the beginning.
If you have the "less" program, you will probably want to use it instead of
"more". You may find that the best version of troff at your site is called
"ptroff" or "dtroff" or "itroff" or "qtroff" or whatever--the first letter
tends to correspond to the manufacturer of the machine for which that troff
is targeted.
Once you have edited your Makefile, type
make configure
This will produce configured executable versions of the cookbook software in
your current directory. Once you have satisfied yourself that it is not a
trojan horse, type
make install
which will copy the executable programs to the directory you have chosen for
them (we put them in /usr/local/bin) and copy the manual pages to
/usr/man/man1 and /usr/man/man5. You needn't be root to install, you only
need to be a user who has write permission in the bin and man directories.
Once you've done that, go read the man pages, then go play with "rn" and have
fun printing cookbooks. This will also work with readnews; I don't know from
notesfiles, and I have never tried it with vnews or yarn or any of those
other programs.
Here are the program names and what they do:
rcbook.t make a cookbook with troff
rcnew.t make a cookbook update with troff
rcextract extract a recipe from a news article (called by rctypeset)
rcindex produce an index of saved recipes (called by rcbook)
rcintro generate the introduction to the cookbook (called by rcbook)
rckeep keep a recipe
rckeepnew keep all new recipes (new since last rckeepnew run)
rcnroff run one recipe through nroff
rcshow show one recipe on the screen
rctypeset run one recipe through troff
rcbook.n nroff version of rcbook.t
rcnew.n nroff version of rcnew.t
The troff and nroff macros use the manual macros /usr/lib/tmac/tmac.an as a
subroutine. If your site has changed those manual page macros significantly
from the original AT&T or Berkeley distribution, then things might not work.
In particular, the macros distributed by DEC with Ultrix 1.2 are not
compatible.
Brian Reid
DEC Western Research Laboratory
Palo Alto, California
decwrl!reid -or- reid@decwrl.DEC.COM
8765!mod.recipes!
echo extracting Makefile.bsd
cat > Makefile.bsd << '8765!mod.recipes!'
# mod.recipes software Makefile. To install, edit the following variables,
# then type "make install"
#
# Where are the object files for the recipe software kept?
OBJDIR=/usr/local/bin
# Where is the news spooling directory? Note: if your system is running a
# version of news earlier than B2.10, or some software besides news, you will
# have to edit the file "rckeepnew.X" and tell it the name of the directory
# that holds mod.recipes articles.
NEWSDIR=/usr/spool/news
# What is the default "keep" directory. If you want a per-person keep
# directory, put $$HOME/something; if you want a systemwide keep directory
# (to save disk space), then put an absolute pathname here.
DEFDIR=$$HOME/Recipes
# What PATH do you want used inside the shell scripts? At the very least,
# it must contain $OBJDIR
DEFPATH=:$(OBJDIR):/usr/ucb:/usr/bin:/bin:
# What version of TRoff works best at your site, and with what options does it
# do its best job on the Unix manual pages macros?
DEFTROFF=troff -man
# What is your favorite pager and what are its options?
DEFPAGER=more -s
# Do you want recipes to come out in Metric units (as opposed to English
# units)? If you think that tablespoons and cups are the right thing to have
# in recipes, then leave this set to "0". If you think that milliliters and
# grams are the right thing to have in recipes, then change to "1"
METRIC=0
##
##########################################################################
OBJECTS=rcbook.t rcbook.n rcextract rcindex rckeep rcnroff rcshow rctypeset \
rcintro rckeepnew rcnew.t rcnew.n
configure: Makefile
sh configure.sh $(OBJDIR) $(NEWSDIR) '$(DEFDIR)' $(DEFPATH) \
'$(DEFTROFF)' '$(DEFPAGER)' '$(METRIC)'
install:
cp $(OBJECTS) $(OBJDIR)
cp cookbook.1 /usr/man/man1
cp recipes.5 /usr/man/man5
8765!mod.recipes!
echo extracting Makefile.sysv
cat > Makefile.sysv << '8765!mod.recipes!'
# mod.recipes software Makefile. To install, edit the following variables,
# then type "make install"
#
# Where are the object files for the recipe software kept?
OBJDIR=/usr/local/bin
# Where is the news spooling directory? Note: if your system is running a
# version of news earlier than B2.10, or some software besides news, you will
# have to edit the file "rckeepnew.X" and tell it the name of the directory
# that holds mod.recipes articles.
NEWSDIR=/usr/spool/news
# What is the default "keep" directory. If you want a per-person keep
# directory, put $$HOME/something; if you want a systemwide keep directory
# (to save disk space), then put an absolute pathname here.
DEFDIR=$$HOME/Recipes
# What PATH do you want used inside the shell scripts? At the very least,
# it must contain $OBJDIR
DEFPATH=:$(OBJDIR):/usr/bin:/bin:
# What version of TRoff works best at your site, and with what options does it
# do its best job on the Unix manual pages macros?
DEFTROFF=troff -man
# What is your favorite pager and what are its options?
DEFPAGER=pg
# Do you want recipes to come out in metric units (as opposed to English
# units)? If you think that tablespoons and cups are the right thing to have
# in recipes, then leave this set to "0". If you think that milliliters and
# grams are the right thing to have in recipes, then change to "1"
METRIC=0
############################################################################
OBJECTS=rcbook.t rcbook.n rcextract rcindex rckeep rcnroff rcshow rctypeset \
rcintro rckeepnew rcnew.t rcnew.n
configure: Makefile
sh configure.sh $(OBJDIR) $(NEWSDIR) '$(DEFDIR)' $(DEFPATH) \
'$(DEFTROFF)' '$(DEFPAGER)' '$(METRIC)'
install:
cp $(OBJECTS) $(OBJDIR)
cp cookbook.1 /usr/man/man1
cp recipes.5 /usr/man/man5
8765!mod.recipes!
echo extracting Novice
cat > Novice << '8765!mod.recipes!'
This file is for people who know how to cook but who don't know how to
program, and who find that they are unable to get the help of a programmer in
getting the mod.recipes software installed.
The novice installation is set up as a series of steps; at the end of each
you will be told what to do next.
To begin, type this command:
Novice.start
Make sure you put the capital N at the beginning of it. If it doesn't work,
try typing this command:
chmod 755 Novice.*
and then try
Novice.start
a second time. If it still doesn't work, then you gotta get help.
8765!mod.recipes!
echo extracting Novice.install
cat > Novice.install << '8765!mod.recipes!'
#! /bin/sh
# This program is part of the novice mod.recipes installation procedure.
# Please read the file "Novice".
trap "rm -f mod.rec.$$" 0 1 2 3 15
echo $$ > mod.rec.$$
if test -f $HOME/mod.rec.$$
then
cat Novice.step3a
else
echo Installing ...
cp $*
cat Novice.step3b
fi
8765!mod.recipes!
echo extracting Novice.makefile
cat > Novice.makefile << '8765!mod.recipes!'
### This file is used as part of the Novice installation procedure. Please
### read file "Novice".
##=
# # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #
# (1) Where is the news spooling directory? If you don't have any idea, then
# leave this line alone--this is the best guess. If you get this wrong,
# all of the programs will still work, though they may give strange error
# messages at times.
NEWSDIR=/usr/spool/news
# (2) What version of troff works best at your site? Change the word "troff"
# to the name of your version, if it is different.
#
# If you don't know, then try one of these guesses:
# If you have an Apple LaserWriter, your best guess is "ptroff"
# If you have an Imagen printer, your best guess is "itroff"
# If you have a QMS or Talaris printer, your best guess is "qtroff"
# Otherwise try just "troff", or ask for help.
# If you get this wrong, you will be able to save recipes but you won't be
# able to typeset them or print them out.
MYTROFF=troff
# (3) What is your favorite pager and what are its options? If you don't have
# any idea, then leave this line alone. If you have a "pg" program, then edit
# the word "cat" into "pg" below. If you have a "more" program, then edit the
# word "cat" into "more". Even if you get this completely wrong, almost
# everything will still work.
DEFPAGER=cat
# (4) Do you want the recipes to come out in metric units or English units?
# If you think that recipes should use teaspoons and cups, then leave the
# METRIC=0 line alone. If you think that recipes should use grams and
# milliliters, then edit this line to say METRIC=1
METRIC=0
# # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #
# You should not have to change anything below this line.
DEFTROFF=$(MYTROFF) -man
DEFDIR=$$HOME/Recipes
OBJDIR=$$HOME
DEFPATH=:$(OBJDIR):XXDEFPATH
OBJECTS=rcbook.t rcbook.n rcextract rcindex rckeep rcnroff rcshow rctypeset \
rcintro
configure: Makefile
@sh configure.sh $(OBJDIR) $(NEWSDIR) '$(DEFDIR)' $(DEFPATH) \
'$(DEFTROFF)' '$(DEFPAGER)' '$(METRIC)'
@cat Novice.step2
install:
@Novice.install $(OBJECTS) $(OBJDIR)
8765!mod.recipes!
echo extracting Novice.start
cat > Novice.start << '8765!mod.recipes!'
#! /bin/sh
# This script is used to begin the Novice installation procedure. Please read
# file "Novice" for instructions. Pay no attention to the man behind the
# curtain.
#
###########################################################################
sed -e "s|XXDEFPATH|$PATH|" \
-e "/###/d" \
-e '/##=/a\
# This version of the mod.recipes Makefile is for people who are not really\
# programmers, and who cannot get other help. Edit the file to answer the 4\
# questions below, and then type "make configure".\
' -e '/##=/d' Novice.makefile > Makefile
cat Novice.step1
8765!mod.recipes!
echo extracting Novice.step1
cat > Novice.step1 << '8765!mod.recipes!'
OK, your Makefile is now created. Using your favorite text editor, edit it to
try to answer the 4 questions at the beginning. If you can't answer them,
don't give up--the system will still work to a certain extent without the
answers.
Once you have finished editing the Makefile, type this:
make configure
8765!mod.recipes!
echo extracting Novice.step2
cat > Novice.step2 << '8765!mod.recipes!'
OK, the mod.recipe software and documentation are now all "configured". That
means that they have been updated to reflect the details of your installation.
What you need to do next is to "install" them, which means to copy them to
your home directory where you can execute them while reading news. To do
that, type this:
make install
8765!mod.recipes!
echo extracting Novice.step3a
cat > Novice.step3a << '8765!mod.recipes!'
Because you have been working in your home directory, the software is already
installed there. We're done! Go read the files "cookbook.doc" and
"recipes.doc" for further instructions on how to use mod.recipes (They are
now in your home directory)
-- Brian Reid
8765!mod.recipes!
echo extracting Novice.step3b
cat > Novice.step3b << '8765!mod.recipes!'
You're done. The programs are all installed. Go read the files "cookbook.doc"
and "recipes.doc" for instructions. Happy recipe collecting!
-- Brian Reid
8765!mod.recipes!
echo extracting cookbook.1.X
cat > cookbook.1.X << '8765!mod.recipes!'
.TH COOKBOOK 1 "28 Mar 86" "USENET Cookbook"
.SH NAME
cookbook: rckeep, rckeepnew, rcbook.t, rcbook.n, rctypeset, rcnroff \- Store and print the mod.recipes USENET Cookbook
.SH SYNOPSIS
.na
.if t .ta 2.5i
.B rckeep < filename
copies a recipe to your keep directory
.br
.B s\ |rckeep
(same thing, from a news-reading program.)
.br
.B rckeepnew [ directory ]
finds and keeps new recipes
.br
\fBrcbook.t [ \-t ] [ \-m ] [ \-M ] \fR
typesets a cookbook from kept recipes
.br
\fBrcbook.n [ \-m ] [ \-M ] \fR
nroffs a cookbook from kept recipes
.br
\fBrctypeset [ \-m ] [ \-M ] \fR
typesets one recipe from std input
.br
\fBrcnroff [ \-m ] [ \-M ] \fR
nroffs one recipe from std input
.br
\fBrcnew.t [ \-m ] [ \-M ] \fR
typesets new kept recipes
.br
\fBrcnew.n [ \-m ] [ \-M ] \fR
nroffs new kept recipes
.ad
.\" This next line supposedly sets default tabs
.DT
.SH DESCRIPTION
The USENET Cookbook is an online database distributed in the
.B mod.recipes
newsgroup. This software makes it easy for you to clip recipes that interest
you, to store them in your own directory, and to make printed cookbooks from
those stored recipes.
.SH SAVING RECIPES ONE AT A TIME
.PP
Read the news with your favorite news reading program. If you don't have a
favorite, try
.B rn.
When you see a recipe that interests you, type
.br
.B s |rckeep
.br
The ``s'' command means ``save''; the vertical bar means ``save into a
program''.
.B rckeep
is the program that keeps recipes. It will save recipes into a directory
named Recipes, and it will create that directory for you if it does not
currently exist. If you would like recipes saved in some other place, you can
type
.br
.B s |rckeep PartyRecipes
.br
.B s |rckeep ~/PartyRecipes
.br
.B s |rckeep /usr/local/lib/Recipes
.br
and so forth.
.SH SAVING NEW RECIPES AUTOMATICALLY
If you don't want to take the time and trouble to run \fBrckeep\fR on every
recipe, you can run \fBrckeepnew\fR from time to time. When \fBrckeepnew\fR
is run, it looks in the netnews spooling directory to find the files that
hold the articles that hold the recipes, and automatically runs \fBrckeep\fR
on every file that contains a recipe and that has arrived since the last time
you ran \fBrckeepnew\fR. Like \fBrckeep\fR, \fBrckeepnew\fR can be given the
name of a directory to use as the keep directory:
.br
.B rckeepnew
.br
or
.br
.B rckeepnew /usr/local/lib/Recipes
.br
and so forth.
.SH HOW RECIPES ARE STORED
Every recipe is given a code word by the editor of mod.recipes. That code
word is contained in the first few lines of the article body. The
.B rckeep
and
.B rckeepnew
programs use that code word as a file name in your keep directory. For
example, if you are saving a recipe whose 1-line description is
.br
.B PHEASANT-PERRY \- Pheasant for Thanksgiving
.br
it will be saved in your keep directory under the filename ``pheasant-perry''.
These filenames are forced to lower case by
.B rckeep.
.SH MAKING A COOKBOOK
To typeset a cookbook, just type
.br
.B rcbook.t
.br
and all of the recipes in your keep directory will be typeset in alphabetical
order, with an index, introduction, and title page added. They will come out
either in English units (cups and teaspoons) or in metric units (grams and
deciliters) depending on how the mod.recipes software has been installed at
your site. If you want to print the cookbook in English units regardless of
what the software installer did, then type
.br
.B rcbook.t \-M
.br
and if you want to print the cookbook in metric units regardless of what the
software installer did, then type
.br
.B rcbook.t \-m
.br
If you don't have a
typesetter or if you don't have the
.B troff(1)
program, then use ``\fBrcbook.n\fR'' instead; it uses
.B nroff(1).
and sends the results of the formatting to standard output. It supports the
same \-m and \-M options that \fBrcbook.t\fR does.
.PP
If you have more than one keep directory, for specialty cookbooks of
different types, you can give rcbook a directory name as an argument, e.g.:
.br
.B rcbook.t /usr/local/lib/Recipes
.PP
You can capture the output of \fBrcbook.t\fR in a file by using the ``\-t''
option:
.br
.B rcbook.t \-t > FormattedFile
.br
.SH PRINTING ONE RECIPE
The program \fBrctypeset\fR typesets one recipe, from its standard input.
It is able to discard news and mail headers from the beginning of the
recipe; you may use \fBrctypeset\fR on a netnews message in the form that it
is stored in a spooling directory, or you may use it directly from a
news-reading program. \fBrctypeset\fR supports the metric (\-m) and
non-metric (\-M) options explained above.
.PP
The program \fBrcnroff\fR performs the same function as \fBrctypeset\fR,
except that it formats to standard output instead of to the typesetter.
.SH PRINTING NEW RECIPES
It is a nuisance to keep track of which recipes you have printed and which
you have not. It is expensive and slow to print the entire cookbook every time
a few more recipes arrive. The \fBrcnew.t\fR program works very much like
\fBrcbook.t\fR, except that it typesets only those recipes that were put
into the keep directory after the last time you ran \fBrcnew.t\fR. It
produces a complete new index, though. It uses the creation time of the file
INDEX in your keep directory to determine the last time you created an
index, which is presumably the last time you ran \fBrcbook.t\fR or
\fBrcnew.t\fR. \fBrcnew.t\fR supports the metric (\-m) and non-metric (\-M)
options explained above.
.PP
The program \fRrcnew.n\fR does the same thing as \fRrcnew.t\fR, except that
it formats to standard output instead of to the typesetter.
.SH COPYRIGHT
The entire USENET cookbook is copyrighted by the USENET Community Trust. The
purpose of this copyright is to prevent commercial use of the material. The
USENET Community Trust permits any noncommercial use of the contents of the
recipe database, and forbids any commercial use.
.SH FILES
.ta 3i
NEWSDIR/mod/recipes USENET recipe directory
.br
DEFDIR Your keep directory (saved recipes)
.br
DEFDIR/.keepnew Record of when rckeepnew last run
.br
DEFDIR/INDEX Record of when rcnew last run
.br
OBJDIR/rc* The recipe software
.SH SEE ALSO
recipes(5), rn(1)
.SH AUTHOR
Brian K. Reid, DEC Western Research Laboratory
8765!mod.recipes!
echo extracting rcbook.t.X
cat > rcbook.t.X << '8765!mod.recipes!'
#! /bin/sh
# rcbook.t - make a cookbook for the typesetter
#
# Brian Reid, November 1985
# Copyright (C) USENET Community Trust
#
TROFF="DEFTROFF"
PATH=DEFPATH
export PATH
TMAC=/tmp/tmac.$$
INDEX=/tmp/Index.$$
RECIPES=/tmp/Recipes.$$
trap "rm -f $TMAC $INDEX $RECIPES" 0 1 2 3 15
TFLAG=
METFLAG="-rMMETRIC"
KEEPDIR=DEFDIR
while [ $# -gt 0 ];
do
case $1 in
-t) TFLAG="$1";;
-m) METFLAG="-rM1";;
-M) METFLAG="-rM0";;
-*) echo $0: Unknown option $1 1>&2 ; exit;;
"") KEEPDIR=DEFDIR;;
*) KEEPDIR=$1;;
esac
shift
done
if [ ! -d $KEEPDIR ]; then
echo Your keep directory $KEEPDIR does not seem to exist. 1>&2
exit 1
fi;
echo Typesetting cookbook from files in $KEEPDIR 1>&2
cd $KEEPDIR
rcindex -t $KEEPDIR
cat > $TMAC << 'tmac.recip'
TMAC.RECIP
tmac.recip
set `date`
# Thu Mar 27 22:56:49 PST 1986
YEAR="$6"
YR=`expr $YEAR - 1900`
TODAY="$3 $2 $YR"
sed -e "s/DATE/$TODAY/g" -e "s/YEAR/$YEAR/g" > $INDEX << 'Index'
.RH MOD.RECIPES-SOURCE INDEX Recipes "DATE" YEAR
.ll 6.5i
.nf
.br
.de XX
.tr ~
.ta 2.4iR 2.6i 5.3i
.ie !"\\$2"" \\$1~~~~~\\$2 \\$3 \\$4 \\$5
.el \\$1 \\$3 \\$4 \\$5
..
.ps 8
.vs 10p
.so INDEX
Index
rcintro > Introduction
cat [a-z]* > $RECIPES
$TROFF $METFLAG $TFLAG $TMAC Introduction $INDEX $RECIPES
8765!mod.recipes!
echo extracting rcextract.X
cat > rcextract.X << '8765!mod.recipes!'
#! /bin/sh
# rcextract - extract article from mod.recipes
#
# This shell script extracts the portion of a mod.recipes
# article that is supposed to be fed into xroff. It strips off the
# article header and any signature, and sends the resulting text to stdout.
#
# Brian Reid, November 1985
# Paul Pomes, March 1986: updated to work with notesfiles
#
# Copyright (C) 1986, USENET Community Trust
PATH=DEFPATH
export PATH
TMPFILE=/tmp/xart.$$
trap "rm -f $TMPFILE; exit" 0 1 2 3 15
cat > $TMPFILE << 'extractor.awk'
BEGIN {Seen = 0}
/^\.RH MOD\.RECIPES/ {Seen = 1}
/^-- *$/ {Seen = 0}
/^\/\* End of text from/ {Seen = 0}
Seen == 1 {print $0}
extractor.awk
awk -f $TMPFILE
8765!mod.recipes!
echo extracting rcindex.X
cat > rcindex.X << '8765!mod.recipes!'
#! /bin/sh
# rcindex - produce index of recipes
#
# usage:
# rcindex [ -options ] [ keepdir ]
#
# This shell script produces an index of all recipes in a keep directory.
# That index is an nroff/troff document that will be used as a part
# of the book produced from that directory.
#
# If you don't specify a keep directory, it will use DEFDIR, which
# is as good a place as any.
#
# Brian Reid, November 1985
# Copyright (C) 1986, USENET Community Trust
#
PATH=DEFPATH
export PATH
case $1 in
-*) OPTIONS=$1; shift;;
*) OPTIONS=;;
esac
case $1 in
"") KEEPDIR=DEFDIR;;
*) KEEPDIR=$1;;
esac
if [ ! -d $KEEPDIR ]; then
echo Your keep directory $KEEPDIR does not seem to exist.
exit 1
fi;
cd $KEEPDIR
grep \^.RZ [a-z]* |\
sed -e 's/\: *.RZ //' |\
awk -F\" '{print $1,$4}' |\
ptx -f -r $OPTIONS |\
sed -e 's/^\.xx/.XX/' > INDEX
8765!mod.recipes!
echo extracting rcintro.X
cat > rcintro.X << '8765!mod.recipes!'
#! /bin/sh
# Copyright (C) 1986, USENET Community Trust
#
cat << 'YumYumEatemup'
.RH MOD.RECIPES-SOURCE INTRODUCTION M "28 Mar 1986" 1986
.SH "\s16THE USENET COOKBOOK\s10"
USENET is the Unix community's communication network. It is used
for communicating information among Unix computer sites
worldwide. The USENET Cookbook is a collection of recipes that were
contributed by USENET members, transmitted electronically to the editor
in California, and then published via USENET.
.PP
.ie t \{The USENET Cookbook is a database and not just a book.
The paper copy that you
are holding was printed from a copy of the online database at some USENET
site, but even as you are reading it, new recipes are being added to that
database. \}
.el \{The USENET Cookbook is an online database distributed with the
intention that it be published as a book. \}
The USENET Cookbook is distributed with software that enables every user to
make his own personal customized edition of it, leaving out the recipes that
he has no interest in, and perhaps adding a few of his own that he hasn't
yet submitted to the network. There will be many different versions and
editions of it, all with the same title, and all copyrighted. Every user can
choose whether to print the recipes in English units or metric units.
.SH DISTRIBUTION
The USENET cookbook is distributed in the newsgroup named ``mod.recipes''.
You will need to get that newsgroup at your site.
A package of software for dealing with mod.recipes, including troff macros,
extraction programs, indexing programs, and this introduction, is posted from
time to time into mod.recipes and net.sources. Get that software and install
it on your machine.
.SH PROCEDURE
To submit a recipe to the USENET cookbook, just mail its text to the
newsgroup moderator, decwrl!mod-recipes by uucp or
mod-recipes@decwrl.DEC.COM by internet. The netnews software on most
machines will do this automatically if you try to post to mod.recipes
.PP
You can also submit evaluations, modifications, suggestions, or bug-fixes to
existing recipes.
.SH THE EDITOR
The editor of the USENET Cookbook is Brian Reid, of DEC Western Research
Laboratory. Like
the editor of any publication, he did not do a majority of the writing. He
has contributed a few of his own recipes, but his contribution is primarily
that he organized the cookbook venture, that he wrote the software that
publishes the cookbook from the online database, and he edits and takes final
responsibility for the appearance and content of recipes that are put into
the database.
.SH NOTES
It's important that you tell us where you got the recipe from. It's ok if you
cribbed it from a book or magazine or newspaper, but if you copy the
words that you found there, you have probably violated a copyright.
.PP
While the main purpose of the USENET cookbook is to let us all make our own
custom cookbooks, we can't ignore the reality of the copyright law. Surely
you have noticed that every modern book says ``\fINo part of this publication
may be reproduced, stored in a retrieval system, or transmitted, in any form
or by any means, electronic, ..., or otherwise without the prior written
permission of the publisher.\fR''
.PP
Copyright law is complex, and only a lawyer
can reliably advise you on whether or not you are violating it, but in
general if you rewrite a recipe, in your own words, even if you don't change
the recipe, then you are not infringing the copyright by submitting that
recipe to the network. The copyright is on the words that explain the recipe,
and not the recipe itself.
.SH COPYRIGHT
The entire USENET Cookbook is Copyrighted by the USENET Community Trust. The
purpose of this copyright is to prevent commercialization or profit-making
use of the Cookbook. As a user of USENET you are explicitly granted
permission to make copies of this material, provided that you don't remove
the copyright notice or the USENET Cookbook label.
.WR
Brian Reid, decwrl!reid, reid@decwrl.DEC.COM
Digital Equipment Corporation, Western Research Laboratory, Palo Alto CA
'YumYumEatemup'
8765!mod.recipes!
echo extracting rckeep.X
cat > rckeep.X << '8765!mod.recipes!'
#! /bin/sh
# rckeep - keep a recipe by adding it to a keep directory
#
# usage:
# rckeep [ keepdir ] [ filename ]
#
# This program lets you snatch recipes out of newsgroups and store them in
# a "keep" directory. They are stored in a file name that matches the
# recipe id, which is found in the .RH command in the recipe.
#
# If you don't specify a keep directory, it will use DEFDIR which
# is as good a place as any. You can use ~/ to stand for $HOME/ if you want.
#
# Brian Reid, November 1985
# Copyright (C) 1986, USENET Community Trust
#
PATH=DEFPATH
export PATH
TEMPFILE=/tmp/rckeep.$$
case $1 in
"") KEEPDIR=DEFDIR;;
~/*) KEEPDIR=$HOME/`expr $1 : '~/\(.*\)'`;;
~*) echo Sorry, I cannot process ~ notation, except for ~/...;
exit 1;;
*) KEEPDIR=$1;;
esac
if [ ! -d $KEEPDIR ]; then
echo Creating new keep directory $KEEPDIR;
mkdir $KEEPDIR;
fi;
case $2 in
"") rcextract > $TEMPFILE;;
*) rcextract < $2 > $TEMPFILE;;
esac
# the [A-Z] in tr arg below is for compatibility with SysV
IDLINE=`awk '{print $2,$3; exit;}' < $TEMPFILE | tr "[A-Z]" "[a-z]" `
case $IDLINE in
"") echo This is not a mod.recipes datafile. I do not know what to do with it.
exit 1;;
esac
set $IDLINE
KEEPNAME=$2
FILETYPE=$1
case $FILETYPE in
mod.recipes-source) if [ -f $KEEPDIR/$KEEPNAME ]; then
echo Overwriting previous version of `basename $KEEPNAME`:
ls -l $KEEPDIR/$KEEPNAME
fi
mv $TEMPFILE $KEEPDIR/$KEEPNAME
echo Saving $KEEPDIR/$KEEPNAME;;
*) echo This is not a mod.recipes datafile. I do not know what to do with it.;
exit 1;;
esac
8765!mod.recipes!
echo extracting rckeepnew.X
cat > rckeepnew.X << '8765!mod.recipes!'
#! /bin/sh
# rckeepnew - keep all recipes that arrived since the last time this
# program was run.
#
# usage:
# rckeepnew [ keepdir ]
#
# This program looks in the USENET spooling directory and finds all files
# that contain recipes and that were created since the last time it was run.
# For each such file, it runs the program "rckeep". The record of the last
# time the program was run is kept as the creation date of the file
# ".keepnew" in your keep directory.
#
# Brian Reid, March 1986
# Copyright (C) 1986, USENET Community Trust
#
PATH=DEFPATH
export PATH
# if you are not running B news, you will need to edit the following line to
# tell it the name of the directory in which mod.recipes articles are stored.
RECIPEDIR=NEWSDIR/mod/recipes
export RECIPEDIR
KEEPDIR=${1-DEFDIR}
cd $RECIPEDIR
# Find the files that have changed
for j in `if test -f $KEEPDIR/.keepnew
then
find . -newer $KEEPDIR/.keepnew -exec grep -l "^Subject: RECIPE:" {} \;
else
grep -l "^Subject: RECIPE:" *
fi`
# run rckeep on each of the changed files
do
rckeep $KEEPDIR < $j
done
# update the date-time flag
touch $KEEPDIR/.keepnew
echo Date-and-time flag in $KEEPDIR updated.
8765!mod.recipes!
echo extracting rcnew.t.X
cat > rcnew.t.X << '8765!mod.recipes!'
#! /bin/sh
# rcnew.t - make new cookbook pages for the typesetter
#
# Spencer Thomas, January 1986
# after rcbook.t by Brian Reid, November 1985
#
TROFF="DEFTROFF"
PATH=DEFPATH
export PATH
TMAC=/tmp/tmac.$$
INDEX=/tmp/Index.$$
RECIPES=/tmp/Recipes.$$
trap "rm -f $TMAC $INDEX $RECIPES; exit" 0 1 2 3 15
TFLAG=
METFLAG="-rMMETRIC"
KEEPDIR=DEFDIR
while [ $# -gt 0 ];
do
case $1 in
-t) TFLAG="$1";;
-m) METFLAG="-rM1";;
-M) METFLAG="-rM0";;
-*) echo $0: Unknown option $1 1>&2 ; exit;;
"") KEEPDIR=DEFDIR;;
*) KEEPDIR=$1;;
esac
shift
done
if [ ! -d $KEEPDIR ]; then
echo Your keep directory $KEEPDIR does not seem to exist. 1>&2
exit 1
fi;
cd $KEEPDIR
# if Index.keep exists, then a previous rcnew bombed. Use the old one.
if [ ! -f Index.keep ]; then
mv INDEX Index.keep
fi;
echo Typesetting cookbook update 1>&2
echo from files newer than \
`ls -l $KEEPDIR/Index.keep | awk '/./ {printf("%s %s %s", $5, $6, $7);}'` 1>&2
echo in $KEEPDIR 1>&2
rcindex -t $KEEPDIR
cat > $TMAC << 'tmac.recip'
TMAC.RECIP
tmac.recip
set `date`
# Thu Mar 27 22:56:49 PST 1986
YEAR="$6"
YR=`expr $YEAR - 1900`
TODAY="$3 $2 $YR"
sed -e "s/DATE/$TODAY/g" -e "s/YEAR/$YEAR/g" > $INDEX << 'Index'
.RH MOD.RECIPES-SOURCE INDEX Recipes "DATE" YEAR
.ll 6.5i
.nf
.br
.de XX
.tr ~
.ta 2.4iR 2.6i 5.3i
.ie !"\\$2"" \\$1~~~~~\\$2 \\$3 \\$4 \\$5
.el \\$1 \\$3 \\$4 \\$5
..
.ps 8
.vs 10p
.so INDEX
Index
rcintro > Introduction
# This next kludge (using file $RECIPES) is because some versions of troff
# can take only a very small number of argument files.
cat `find . -name '[a-z]*' -newer Index.keep -print | grep '^./[^/]*$'` > $RECIPES
$TROFF $METFLAG $TFLAG $TMAC Introduction $INDEX $RECIPES
rm Index.keep
8765!mod.recipes!
echo extracting rcnroff.X
cat > rcnroff.X << '8765!mod.recipes!'
#! /bin/sh
# rctypeset - typeset a recipe
#
# This shell script extracts a recipe from a mod.recipes netnews article and
# formats it with nroff. It first strips all communication headers
# (such as netnews or mail or notesfile headers) from the front and back
# of the recipe.
#
# Brian Reid, November 1985
# Copyright (C) 1986, USENET Community Trust
#
TROFF="nroff -man"
PATH=DEFPATH
export PATH
TMPFILE=/tmp/xart.$$
TMAC=/tmp/tmac.$$
METFLAG="-rMMETRIC"
trap "rm -f $TMPFILE $TMAC; exit" 0 1 2 3 15
while [ $# -gt 0 ];
do
case $1 in
-m) METFLAG="-rM1";;
-M) METFLAG="-rM0";;
-*) echo $0: Unknown option $1 1>&2 ; exit;;
esac
shift
done
cat > $TMPFILE << 'extractor.awk'
BEGIN {Seen = 0}
/^\.RH MOD\.RECIPES/ {Seen = 1}
/^-- *$/ {Seen = 0}
/^\/\* End of text from/ {Seen = 0}
Seen == 1 {print $0}
extractor.awk
cat > $TMAC << 'tmac.recip'
TMAC.RECIP
tmac.recip
awk -f $TMPFILE |\
$TROFF $METFLAG $TMAC -
8765!mod.recipes!
echo extracting rcshow.X
cat > rcshow.X << '8765!mod.recipes!'
#! /bin/sh
# rcshow - show a recipe
#
# This shell script extracts a recipe from a mod.recipes netnews article and
# nroffs it for display on the screen. This differs slightly from "rcnroff"
# in that it is not page-oriented. Actually, this program is almost too slow
# to use, because it has to run nroff every time.
#
# Brian Reid, November 1985
# Copyright (C) 1986, USENET Community Trust
#
# If you don't have "less", you will want to
# add "ul" to the pipeline to get the underlines right.
TROFF="nroff -man"
PAGER="DEFPAGER"
PATH=DEFPATH
export PATH
TMPFILE=/tmp/xart.$$
TMAC=/tmp/tmac.$$
trap "rm -f $TMPFILE $TMAC" 0 1 2 3 15
METFLAG="-rMMETRIC"
cat > $TMPFILE << 'extractor.awk'
BEGIN {Seen = 0}
/^\.RH MOD\.RECIPES/ {Seen = 1}
/^-- *$/ {Seen = 0}
Seen == 1 {print $0}
extractor.awk
cat > $TMAC << 'tmac.recip'
TMAC.RECIP
tmac.recip
awk -f $TMPFILE |\
$TROFF $TMAC $METFLAG - | $PAGER
# if you don't have "less", you will probably want to change the above line
# into $TROFF $TMAC - | ul | $PAGER
8765!mod.recipes!
echo extracting rctypeset.X
cat > rctypeset.X << '8765!mod.recipes!'
#! /bin/sh
# rctypeset - typeset a recipe
#
# This shell script extracts a recipe from a mod.recipes netnews article and
# typesets it with troff. It first strips all communication headers
# (such as netnews or mail or notesfile headers) from the front and back
# of the recipe.
#
# Brian Reid, November 1985
# Copyright (C) 1986, USENET Community Trust
#
TROFF="DEFTROFF"
PATH=DEFPATH
export PATH
TMPFILE=/tmp/xart.$$
TMAC=/tmp/tmac.$$
METFLAG="-rMMETRIC"
trap "rm -f $TMPFILE $TMAC; exit" 0 1 2 3 15
while [ $# -gt 0 ];
do
case $1 in
-t) TFLAG="$1";;
-m) METFLAG="-rM1";;
-M) METFLAG="-rM0";;
-*) echo $0: Unknown option $1 1>&2 ; exit;;
esac
shift
done
cat > $TMPFILE << 'extractor.awk'
BEGIN {Seen = 0}
/^\.RH MOD\.RECIPES/ {Seen = 1}
/^-- *$/ {Seen = 0}
/^\/\* End of text from/ {Seen = 0}
Seen == 1 {print $0}
extractor.awk
cat > $TMAC << 'tmac.recip'
TMAC.RECIP
tmac.recip
awk -f $TMPFILE |\
$TROFF $TFLAG $METFLAG $TMAC -
8765!mod.recipes!
echo extracting recipes.5.X
cat > recipes.5.X << '8765!mod.recipes!'
.TH RECIPES 5 "28 Mar 86" "USENET Cookbook"
.SH NAME
recipes \- USENET Cookbook (mod.recipes) format and submitting procedure.
.SH SYNOPSIS
Mail your recipe to mod-recipes@decwrl. Try not to plagiarize.
If you want to put in your own troff commands, use the Unix manual macros.
.SH DESCRIPTION
Mod.recipes is a ``moderated newsgroup''. This means that you mail your
submissions to the moderator, and he distributes them.
The moderator's mailbox is
.br
decwrl!mod-recipes,
.br
if you believe in that kind of address, or
.br
{ihnp4, decvax, ucbvax, glacier}!decwrl!mod-recipes
.br
if you believe in the other kind of address. The address
.br
mod-recipes@decwrl.DEC.COM
.br
also works, if you know how to mail to it.
.PP
If your netnews administrator has set things up properly and if you are
running the right news software, you can just post to mod.recipes as you
would any other group, but your posting will be mailed to the moderator
insted of being placed directly in the newsgroup.
.SH HOW TO STRUCTURE A RECIPE
Every recipe that goes out will be formatted with a small set of troff
commands. If you don't know any troff, then just send the text of your
recipe. If you can do the formatting yourself, then please do! That will
save the editor a lot of time, and your recipe will go out sooner. Some
hints for how to do it are in a later section of this document. If you
don't know about xroff/troff/nroff but you do want to be helpful, then you
can help a lot by doing these things:
.PP
.IP "(1)" 5
Put your recipe in the standard sequence:
.IP "(2)" 5
Don't put any tab characters (^I) in the file if you can possibly avoid it.
They do strange things on typesetters.
.IP "(3)" 5
If you are a troff wizard, please don't use any of that wizardry in these
recipes. If you stick to the set of commands used in the Unix manual macros
(see \fIman(7)\fR), and the set of commands that are part of the USENET
Cookbook package (see following section), then things should work OK.
.br
There are plenty of places in troff where you can get away with not
using quotes around macro arguments. Please use quotes, even when they are
redundant, such as in ``.IG "1" "onion"'' This is because the indexing and
cross-referencing programs expect to find the quotes, even though troff can
work without them.
.RE
The ``standard sequence'' for a recipe is this:
.RS
.IP (a) 5
Title and 1-line description
.IP (b) 5
Introductory commentary, explaining (if possible) where you got
the recipe from and what you like about it.
.IP (c) 5
List of ingredients, using ``Tbsp'', ``tsp'', ``cup'', ``oz'', and ``lb''
for English units, or ``ml'', ``dl'', ``l'', ``g'', and ``kg'' for metric
units. Stay away from ``pint'', ``quart'', and ``gallon'', because they have
different meanings in different countries.
The ingredients should be listed in the order they will
be used. Don't capitalize ingredient names unless they are proper nouns. Try
to avoid terms like ``1 box'' or ``1 can'' or ``1 package'', because packaging
conventions vary widely from place to place. If you must say ``1 can of
soup'', then at least tell me how big you think a can of soup is.
.IP (d) 5
Numbered sequence of recipe steps. Be very careful to mention every
ingredient somewhere. The most common mistake made in recipes is to omit one
or more ingredients from the procedure steps.
.IP (e) 5
Notes (if any). Comments on how you like to make it, ingredient
availability, comments about specific brands, etc.
.IP (f) 5
Your ``signature''. This should include your name and net address, the
organization that you are a part of, and the name of the city it is in. It can
also include other frivolity or foolishness if you like; I'll include as
much of it as will fit on the page.
.RE
.SH COPYRIGHT NOTES
Tell us where you got the recipe from. It's ok if you
cribbed it from a book or magazine or newspaper, but if you copy exactly the
words that you found there, there might be a problem with copyright violation.
The copyright of a recipe is not on the formula, but on the words. If you
have copied the words out of a copyrighted cookbook, then you are infringing
its copyright.
.PP
While the main purpose of the USENET cookbook is to let us all make our own
custom cookbooks, we can't ignore the reality of the copyright law. Surely
you have noticed that every modern book says ``\fINo part of this publication
may be reproduced, stored in a retrieval system, or transmitted, in any form
or by any means, electronic, ..., or otherwise without the prior written
permission of the publisher.\fR''
.PP
Copyright law is complex, and only a lawyer who specializes in copyright
can reliably advise you on whether or not you are violating it, but in
general if you rewrite a recipe, in your own words, even if you don't change
the formula, then you are not infringing the copyright by submitting that
recipe to the network. The copyright is on the words that explain the recipe,
and on the title of the recipe, not the formula itself.
.PP
The USENET Cookbook itself is copyrighted. Every recipe is sent out with a
copyright notice, and the macros that print the cookbooks add a copyright
notice to the bottom of each page. The purpose of this is to prevent
unauthorized commercial use of the USENET Cookbook.
.SH DO YOUR OWN FORMATTING
If you put formatting commands in the recipes that you submit, they will go
out more quickly, since the editor won't have to do it.
It's easy to do.
.PP
The basic principle is to use as few commands as possible, and in general to
use only commands that are defined in the manual macros or the recipe macro
package. Various processing programs search through these files and look for
string matches on things like ``.IG'' and ``.RZ''.
Print out a few of the recipe source files from NEWSDIR/mod/recipes,
and then use OBJDIR/rctypeset
or OBJDIR/rcnroff to produce
formatted versions of them. Have that at hand when you are formatting
your recipe. You can test your formatting by using rctypeset or rcnroff on
your draft versions before you submit the recipe.
.PP
A ``skeleton'' recipe follows. .RH is the recipe header command; it must be
the first line of each recipe and it must have 4 arguments.
``RECIPE-ID'' is the file name under which the recipe will be stored. Normally
the editor chooses the recipe id, but you can put a suggestion there if you
like. It must be 14 characters or less, and must not duplicate any previous
or pending recipe id. The ``?'' is a ``what kind of recipe'' code from the
code table below.
.PP
.nf
.ta 3i
.RS 4
\&.RH MOD.RECIPES-SOURCE RECIPE-ID ? "22 Dec 83"
\&.RZ "RECIPE TITLE IN CAPITALS" "One-line description of it"
Introductory comments; use .PP between paragraphs.
\&.IH "Makes 4 cups" \(<- Ingredients Header
\&.IG "1/2 cup" "butter" \(<- Ingredient (please use quotes)
\&.IG "1" "onion"
(medium to large, chopped fine. Don't try to use instant onion
in this recipe)
\&.PH \(<- Procedure header
\&.SK 1 \(<- Procedure step
Boil the water. \(<- Text for that step
\&.SK 2 \(<- and so forth.
\&.NX \(<- Notes header
Notes (commentary) goes here; use .PP to separate paragraphs.
\&.WR \(<- Wrapup
Signature information goes here. As a minimum you should list your name,
network address, organization (company, university, etc.), and the city you
live or work in.
.RE 4
.fi
Remember that when you post to a moderated newsgroup, the news software
usually forgets to include your .signature file, so you should be sure to
include it manually. If it manages to get there twice, I will remove the
extra copy.
.PP
You can also use the following -man macros; see \fIman(7)\fR for the complete
list.
.nf
.RS 4
.ta 3i
\&.I "italic words"
\&.B "boldface words"
\&.SM "small words"
\&.PP \(<- paragraph break
\&.PD <distance> \(<- paragraph distance
\&.IP "indented paragraph".
\&.RS \(<- relative start: move things to the right
\&.RE \(<- relative end: move things left again
.RE 4
.fi
You can also use these nroff/troff commands:
\\fI,
\\fB,
\\fR,
\&.if,
\&.ds,
\&.br,
\&.nf,
\&.fi,
and .ta
.SH MET\&RIC OR ENGLISH MEASUREMENT?
Most countries in the world use metric measurements for their recipes. The
U.S. defiantly uses the English measurement system of teaspoons and cups,
and every attempt to convert U.S. cooks to the metric system has failed.
Most Americans have never even seen a metric recipe, and virtually no
American cook owns any kind of metric kitchen measures.
.PP
But mod.recipes is international in scope, and we want the recipes to be
accessible to everyone. Therefore the recipes that are posted all have a
dual measurement system in them, both English and metric. When a cookbook
page is printed, a troff/nroff option determines whether or not it will be
printed with English units or metric units.
.PP
The dual-system measurement scheme is accomplished by having both sets of
values stored in the body of the recipe, and having the software select one
or the other when the recipe is printed. This means that somebody has
converted the recipe to both sets of units, and has edited in both sets of
measurements.
.PP
There are four places in a recipe where the system of measurement matters:
the ingredient list, commentary about ingredients, references to ingredients
in the text, and references to temperature in the text. There is a
troff/nroff command for each one of those situations.
Because mod.recipes originated in the U.S., the U.S. (``English'')
measurement system is always given first in all of these commands.
.RS
\fBIngredient header.\fR The ``.IH'' command takes two arguments. The first
is the English-unit specification of how much the recipe produces, and the
second (if present) is the metric specification of the same thing.
.PP
\fBIngredient list.\fR The ``.IG'' command takes an optional third
argument, which is the metric description of the quantity of the ingredient.
For counts\(em3 onions, 2 eggs\(emthe metric description will be the same
and you can leave it off.
.PP
\fBReferences to ingredients.\fR In the text you might want to say
something like ``set aside \(12 Tbsp of the ginger'' or ``reserve 100 ml of
the sauce''. For that purpose there is a macro ``.AB'', that takes two
arguments and prints one or the other, but never both.
.PP
\fBReferences to temperature.\fR The U.S. uses Fahrenheit degrees; nearly
everyone else uses Celsius or Centigrade. Troff can print a ``degree'' sign,
but nroff cannot. To solve these two problems simultaneously, there is a
``.TE'' macro, for indicating temperature. It takes two numeric arguments,
the first a Fahrenheit temperature and the second a Celsius temperature.
.RE
In case the .AB or .TE expression needs to be the end of a sentence, the
macro can take a third argument, which is the punctuation character at
the end of the sentence. For example, you would type
.nf
.RS 4
Then add butter
\&.AB "1 Tbsp" "30 g"
at a time. Lick the spoon to use the last
\&.AB "tablespoon" "few grams" .
.fi
.PP
Here is the example of the previous section, updated to include
international multi-unit arguments to all of the macro calls:
.nf
.ta 3i
.RS 4
\&.RH MOD.RECIPES-SOURCE RECIPE-ID ? "22 Dec 83"
\&.RZ "RECIPE TITLE IN CAPITALS" "One-line description of it"
Introductory comments; use .PP between paragraphs.
\&.IH "Makes 4 cups" "Makes 1 liter" \(<- Ingredients Header
\&.IG "1/2 cup" "butter" "100 g" \(<- Ingredient (please use quotes)
(or use a mixture of
\&.AB "1/4 cup" "50 g" \(<- In-text reference to two systems
of margarine and
\&.AB "1/4 cup" "50 g"
of butter.
\&.IG "1" "onion" \(<- No need for 2 systems here
(medium to large, chopped fine. Don't try to use instant onion
in this recipe)
\&.PH \(<- Procedure header
\&.SK 1 \(<- Procedure step
Preheat the oven to \(<- Text for that step
\&.TE 350 175 \(<- Dual-system temperature
before soaking the rice.
Boil the water.
\&.SK 2 \(<- and so forth.
\&.NX \(<- Notes header
Notes (commentary) goes here; use .PP to separate paragraphs.
\&.WR \(<- Wrapup
Signature information goes here. As a minimum you should list your name,
network address, organization (company, university, etc.), and the city
and country you live or work in.
.RE 4
.fi
.SH CONVERTING RECIPES TO/FROM MET\&RIC
Don't try to convert a recipe to metric units unless you have some
experience cooking with metric, and don't try to convert a recipe to English
units unless you have some experience cooking with them. Submit your recipe
in the units that you are comfortable with, and let the mod.recipes editor
do the conversion for you. It's not just a simple matter of unit conversion,
because most most ingredients are specified by weight in metric recipes and
by volume in English recipes.
.SH CATEGORY CODES
.nf
.ta .4i 1i 3i 3.6i
M Main dish SL Salad
A Appetizer or snack SP Soup
B Bread/cake/pasta D Dessert
L Beverage (Liquid) V Vegetable dish
.fi
The suffix ``V'' on any category means that it is vegetarian; for example, a
vegetarian main dish recipe would be marked ``MV''.
.SH SEE ALSO
cookbook(1), rn(1)
.SH AUTHOR
Brian Reid, DEC Western Research Laboratory
8765!mod.recipes!
echo extracting configure.sh
cat > configure.sh << '8765!mod.recipes!'
#! /bin/sh
# Script to configure and install the other shell scripts for mod.recipes.
# Brian Reid, December 1985
# v2 April 1986
#
OBJDIR="$1"
NEWSDIR="$2"
DEFDIR="$3"
DEFPATH="$4"
DEFTROFF="$5"
DEFPAGER="$6"
METRIC="$7"
# make rcbook.n.X from rcbook.t.X
sed -e "s+DEFTROFF+nroff -man+" \
-e "s+for the typesetter+with nroff+" \
-e "s+Typesetting+Formatting+" \
-e "/^rcindex/s+ -t++" \
-e '/^\$TROFF/s+$+ > Cookbook.nr+' \
-e '/^\$TROFF/a\
echo Cookbook.nr created 1>&2' \
< rcbook.t.X > rcbook.n.X
# make rcnew.n.X from rcnew.t.X
sed -e "s+DEFTROFF+nroff -man+" \
-e "s+for the typesetter+with nroff+" \
-e "s+Typesetting+Formatting+" \
-e "/^rcindex/s+ -t++" \
-e '/^\$TROFF/s+$+ > Update.nr+' \
-e '/^\$TROFF/a\
echo Update.nr created 1>&2' \
< rcnew.t.X > rcnew.n.X
# make rcnroff.X from rctypeset.X
sed -e "s+DEFTROFF+nroff -man+" \
-e "s+typesets it with troff+formats it with nroff+" \
-e "/-t)/d" \
-e '/^\$TROFF/s+$+ > Update.nr+' \
-e 's/$TFLAG//g' \
< rctypeset.X > rcnroff.X
# now configure the executable programs
for i in *.X
do
j=`basename $i .X`
echo Processing $i into $j
sed -e "s+OBJDIR+$OBJDIR+g" \
-e "s+NEWSDIR+$NEWSDIR+g" \
-e "s+DEFDIR+$DEFDIR+g" \
-e "s+DEFPATH+$DEFPATH+g" \
-e "s+DEFPAGER+$DEFPAGER+g" \
-e "s+METRIC+$METRIC+g" \
-e '/^TMAC.RECIP$/r tmac.recip' \
-e '/^TMAC.RECIP$/d' \
-e "s+DEFTROFF+$DEFTROFF+g" < $i > $j
chmod 755 $j
done
8765!mod.recipes!
echo extracting tmac.recip
cat > tmac.recip << '8765!mod.recipes!'
.\" Macro package Copyright (C) 1986 USENET Community Trust
.\"
.\" # Recipe Heading
.de RH
.ie '\\$5'' .ds YR 1985
.el .ds YR \\$5
.ie n .ds YC Copyright \\*(YR USENET
.el .ds YC Copyright \(co \\*(YR USENET Community Trust
.ie n .TH \\$2 "\\$3" "\\*(YC" "\\$4" "USENET Cookbook"
.el .TH \\$2 "\\$3" "\\*(YC" "mod.recipes \\$4" "USENET Cookbook"
.ds ]H \\$2
..
.de RZ
.SH \\s14\\$1
\\*(]H \- \\$2
.PP
..
.\" # Ingredient
.de IG
.ds =1 \\$1
.ds =2 \\$2
.if \\n(.$>2 .if \\nM .ds =1 \\$3
.TP 10
\&\\*(=1
.I \\*(=2
..
.\" # Step
.de SK
.IP "(\\$1)" 5n
..
.\" # Ingredient header
.de IH
.ds =1 \\$1
.if \\n(.$>1 .if \\nM .ds =1 \\$2
.SH INGREDIENTS (\\*(=1)
.PD 0
..
.\" # Procedure header
.de PH
.PD
.ie '\\$1'' .SH PROCEDURE
.el .SH PROCEDURE \\$1
.RS 5
..
.\" # Temperature value
.de TE
.ds =2
.if \\n($>2 .ds =2 \\$3
.ie n .ds =1 \\$1 deg. F
.el .ds =1 \\$1\(deF
.ie n .if \\n(.$>1 .if \\nM .ds =1 \\$2 deg. C
.el .if \\n(.$>1 .if \\nM .ds =1 \\$2\(deC
\\*(=1\\*(=2
..
.\" # inline value selector
.de AB
.ds =1 \\$1
.if \\nM .ds =1 \\$2
.ds =2
.if \\n($>2 .ds =2 \\$3
\\*(=1\\*(=2
..
.\" # Notes
.de NX
.PD
.SH NOTES
..
.\" # Wrapup
.de WR
.RE 5
.PD
.SH CONTRIBUTOR
.nf
..
.\" these macros courtesy of Bernie Cosell and Matt Bishop
.de CS \" do the fancy "go into cs mode right" guy
. ie \\n(.z .cs \\$1 \\$2 \\$3
. el \!.CS \\$1 \\$2 \\$3
..
.de FW \" Go into fixed-width mode: put both italic and bold fonts in it
. CS B 21 \\(.s
. CS I 21 \\(.s
. ss 24
. lg 0
..
.
.de Fw \" Leave fixed-width mode
. CS B
. CS I
. ss 12
. lg 1
..
8765!mod.recipes!