ASSEMBLE

Section: User Commands (1)
Updated: 7 October 1988
Index Return to Main Contents

NAME

assemble - gather files that constitute a posting into a single directory
archive - move program directory into the appropriate place in an archive tree
retrieve - put an expanded archive file in the current directory

SYNOPSIS

assemble [-a archive-directory [-v archive-volume]] [-s] [-e file-name ...]

-n archive-name first-issue [number-of-issues]

archive [-a archive-directory [-v archive-volume]] archive-name

retrieve [-a archive-directory [-v archive-volume]] archive-name

DESCRIPTION

Assemble is a C-shell script that permits the assembly of a group of related files (generally from UseNet newsgroup postings) into archive-name for archiving. Unshar (or tar) is applied to the files, which are then moved into a subdirectory for later removal. If uhshar produces a .hdr header file, it is moved into HDRS; saving headers can be helpful in identifying the source of the posting at a later date. The names of the files themselves are saved in FILES and will be deleted by assemble. If a manifest is posted, it will be checked. If files with an appropriate extension (.man, .nro, .[1-8]) are found within the directory, nroff -man will be applied to each, the result being stored in a subdirectory under manl within the archive.

The files to be assembled may be specified either as a starting issue number (with optional number of issues) or (with the -e option), a file name. In the former case, the name of the file to be retrieved is implied from the name of the ARCVOL directory. For instance, if we are dealing with comp.sources.unix volume 16, we will be assembling files whose name is of the form v16innn. Assuming that the archive has been set up with ARCDIR set to "unix" ARCVOL set to "16", assemble -n example 23 4 will assemble and v16i026 from unix/v16 relative to the base directory specified by ARCHIVE into the directory example

Archive is a C-shell script that permits an assembled set of files to be archived in the user's archive hierarchy. The directory specified by archive-name is saved as a compressed tar file. If archive-name.tar.Z exists, it is silently replaced by the new file. Within the archive-name directory, the directory ARCF is removed and the files specified by FILES are deleted.

Retrieve is a C-shell script that permits an archived directory to be copied form the archive hierarchy and restored in conventional form in the current directory. The archive file is untouched.

OPTIONS

-a archive-directory: The archive directory. This directory (which must already exist) is on the first level below the archive base, which is specified by the environment variable ARCHIVE. The specification for -a overrides the value of the environment variable ARCDIR. If -a is used, -v is required.
-e: The extract flag can be set to indicated that even though a directory is a moderated newsgroup, the file(s) are to be extracted by name rather than by number. This option is useful if you are re-organizing an existing directory.
-n archive-name: The name given to the directory into which files are assembled and from which an archive file is created by archive. The archive-name given to retrieve implies archive-name.tar.Z within the archive directory.
-s: Short assemble. "Just the files, ma'm."
-v archive-volume: The archive volume. This directory (which must already exist) is on the second level of the archive, below ARCDIR. It is useful for the management of moderated newsgroups. -v overrides the value of the environment variable ARCVOL. If is used, is required.

ENVIRONMENT VARIABLES

ARCHIVE: Specifies the path (full or relative, as appropriate) for the directory in which the archives directories are maintained. ARCHIVE must be defined, or an equivalent definition made in assemble and narc.
ARCDIR: Specifies the volume used for archiving. If not defined, -a must be used with all commands. Value is overridden by -a.
ARCVOL: Specifies the volume used for archiving. Relevant only if ARCDIR is a moderated newsgroup. If not defined, -v must be used with all commands. Value is overridden by -v.

DIAGNOSTICS

Prompts are provided if archive-directory or archive-name is missing where required.

"File not found" is given if a file specified or implied by a command is not located, but the script will attempt to go on, especially if a range of files is implied.

CheckManifest and roffit Are called by assemble. They have their own diagnostics.

FILES

ARCF: Subdirectory created to hold the original files prior to deletion by archive.
FILES: List of files used to create the archive. Created by assemble for deletion by archive.
HDRS: A subdirectory created for the saving of the .hdr file left behind by the action of (some) unshar programs.
manl: A subdirectory in the ARCHIVE directory where a subdirectory for archive-name is created to hold formatted man pages.
PATCHES: A handy directory created for later collection of patches.

EXAMPLE

Here is a sample archive directory:

/dbase/central/news/netsrc/x:
v00     v01

/dbase/central/news/netsrc/x/v00:
Index           Indexr          awm.tar.Z       xwatch.tar.Z

/dbase/central/news/netsrc/x/v01:
Index           menupane.tar.Z  xfig.tar.Z      xmoire.tar.Z    xsecure.tar.Z
Indexr          qix.tar.Z               xipr.tar.Z      xphoon.tar.Z    xtools.tar.Z
dclock.tar.Z    twm.tar.Z       xmille.tar.Z    xplaces.tar.Z

BUGS

Individual users will want to modify to their tastes and needs. The author is continually fiddling with them. Assemble assumes you're using the version of shar posted by Rick $altz to comp.sources.unix. Not a Bourne shell script (sorry). Would probably be better as a perl script.

AUTHOR

Geoffrey Leach
{att,bellcore,sun,ames,pyramid}!pacbell!laticorp!geoff

This document was created by man2html, using the manual pages.
Time: 21:52:16 GMT, February 02, 2023