ADEBUN(1) General Commands Manual ADEBUN(1)
NAME
adebun - release builder
SYNOPSIS
adebun [ -V | --version ] [ -v | --verbose | -d level | --debug=level ]
[ -h | --help ] [ -p | --paths ] [ -n | --simulate ] [ --au-
thor-name=name ] [ --author-email=addr ] [ --package-name=pkg ] [ -o
file | --output-file=file ] [ -m cmd | --make=cmd ] srcdir
DESCRIPTION
Adebun prepares .tar.gz files for release from a source directory. It
does this according to the following procedure:
1 Copy srcdir to a temporary location.
2 Substitute occurrences of the following symbols in the tempo-
rary copy of the sources for the text described:
ADE_APP_TOKEN_RELEASE_ID release id, as specified in the
doc/ChangeLog file under srcdir,
ADE_APP_TOKEN_RELEASE_YEAR
The year of release, as determined
by current time
ADE_APP_TOKEN_AUTHOR_NAME
The name of the author, as specified
by command line options,
ADE_APP_TOKEN_AUTHOR_EMAIL
the email address of the author, as
specified by command line options.
ADE_APP_TOKEN_RELEASE_YEAR_MAN
The date of release, as determined
by the current time, in the format
required for the .TH directive (see
man(7) in manual page sources).
It is not an error for there to be no occurrences of the sym-
bols which are specified by options, but it is an error for
there to be occurrences of these symbols without the corre-
sponding options.
3 Clean the temporary copy of the sources by running the com-
mand make clean distclean in the top directory of the tempo-
rary copy. No output is produced from this stage.
4 Pack the remaining files up using tar(1), creating the file
pkg-releaseid.tar.gz, where pkg is determined from the last
component of the directory referred to by srcdir.
5 Delete the temporary copy of the sources.
CONFIGURATION
Make sure that your top-level Makefile (see make(1)) includes targets
clean and distclean. Often the target distclean depends on the clean
target. Its effect should be to remove any build configuration files or
cache files.
Adebun expects that the first line of the file srcdir/doc/ChangeLog be
of the format:
Release release-id (date)
If it is not in this format adebun will complain.
OPTIONS
-d level, --debug=level Determines how verbose this program will be.
The message types displayed for the different
values of level are as follows: 0 displays no
messages; 1 displays only errors, 2 displays
errors and warnings; 3 displays errors, warn-
ings and informational messages; higher values
display errors, warnings, informational mes-
sages and various messages intended for debug-
ging. The default is 2.
-h, --help Displays a brief usage message.
-p, --paths Lists the compiled-in paths of various files
and directories that this program uses. -n,
--simulate Some external commands that this
program runs may be displayed rather than ac-
tually executed. BEWARE: different programs
implement different levels of simulation; so
this option may work perfectly; on the other
hand it may do nothing at all!
-v, --verbose Equivalent to -d 3.
-V, --version Prints the program's version number and exits.
--author-email=addr Sets the author's email address to addr.
--author-name=name Sets the author's name to name.
-m cmd, --make=cmd Specify the location of make(1), used when
running make clean distclean.
-o file, --output-file=file
Specify the name of the output file. The de-
fault is pkg-releaseid.tar.gz, where pkg is
the last component of the source directory hi-
erarchy, as defined by the command line argu-
ment srcdir.
--package-name=pkg Specify an alternative name for the packaged
software. The default is the last component of
the source directory.
EXIT STATUS
On success adebun returns zero. On failure it returns non-zero and dis-
plays a diagnostic message.
FILES
None.
ENVIRONMENT VARIABLES
None.
EXAMPLES
The following command executed one directory above 'foo' would generate
a file 'foo-1.0.tar.gz':
{
echo Release 1.0 ($(date))
echo
cat foo/doc/ChangeLog
} > /tmp/blah
mv /tmp/blah foo/doc/ChangeLog
adebun foo
If you were already in the directory 'foo', and the sources contained
the above optional symbols, and the above commands to prepare the
ChangeLog had been executed, then this might be useful:
adebun -o ../foo-1.0.tgz --author-email=blobber@blobber.com \
--author-name="Bobby Blobber" .
CAVEATS
Don't try to create the tar file inside the source directory; the out-
put file is opened before the source hierarchy is copied.
Regardless of the name of the output specified with the -o option, the
output file will contain paths based on the package name (in turn de-
termined by the --package-name option or the last component of the di-
rectory referenced by srcdir) and the release id.
STANDARDS
This manual page documents version ADE_APP_TOKEN_RELEASE_ID of adebun.
SEE ALSO
tar(1), make(1), perl(1), ade-config(1), date(1)
AUTHOR
ADE_APP_TOKEN_AUTHOR_NAME <ADE_APP_TOKEN_AUTHOR_EMAIL>
COPYRIGHT & DISTRIBUTION POLICY
Copyright (C) 1997-ADE_APP_TOKEN_RELEASE_YEAR ADE_APP_TOKEN_AUTHOR_NAME
This program 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.
This program is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY; without even the implied warranty of MER-
CHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General
Public License for more details.
You should have received a copy of the GNU General Public License along
with this program; if not, write to the Free Software Foundation, Inc.,
675 Mass Ave, Cambridge, MA 02139, USA.
ADE_APP_TOKEN_RELEASE_DATE_MAN ADEBUN(1)
