1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124
|
# pod2man --section=1 --release="Debian" --center=" " --date="23 Nov 2003"
#
# $Id: yada.pod,v 1.2 2003/11/26 13:45:08 dexter Exp $
=head1 NAME
yada - Yet Another Debianisation Aid
=head1 SYNOPSIS
B<yada> B<yada>
B<yada> B<rebuild> S<[I<file>]>
=head1 DESCRIPTION
B<yada> is a Debian packaging helper. It is intended to keep all the
information relating to building and cleaning the source and binary
packages into a single place, and to allow you to specify as much as
possible of this declaratively. The ``single place'' is an augmented Debian
control file named F<debian/packages>, whose format is described in
B<packages>(7).
The basic idea is very simple: everything that used to be scattered amongst
many little files in your F<debian/> directory is now concentrated into a
single file, F<debian/packages>. There are only a couple of exceptions:
F<debian/changelog> is unchanged, and optional F<debian/yada> is the yada
script. F<debian/rules>, F<debian/control> and optional F<debian/templates>
are now generated from F<debian/packages> by B<yada>. Most of the other
files in F<debian/> will then likely be redundant.
So the only thing you now need to know to switch to B<yada> is how to write
F<debian/packages>! See B<packages>(7) for the gory details.
When you've written F<debian/packages>, you'll want to run B<yada> B<yada>
in order to install the B<changelog> file into your F<debian/> directory,
and then run B<yada> B<generate> in order to generate your new
F<debian/rules> and F<debian/control>. After that, your B<rules> file
should automatically regenerate both itself and F<debian/control> as
necessary. Failing that, run B<yada> B<generate> B<rules> or B<yada>
B<generate> B<control> as required.
=head1 OPTIONS
=over 8
=item B<yada>
This command creates an skeleton F<debian/packages> file for you to fill in,
if you don't already have one and creates F<debian/changelog> for initial
release.
=item B<rebuild> B<rules>
B<yada> reads F<debian/packages> and generates a new B<rules> file,
F<debian/rules>. Note that any existing rules file will be overwritten, and
no backup will be kept.
=item B<rebuild> B<control>
B<yada> reads F<debian/packages> and generates a new B<control> file,
F<debian/control>. Note that any existing control file will be overwritten,
and no backup will be kept.
=item B<rebuild> B<templates>
B<yada> reads F<debian/packages> and generates a new optional B<templates>
file, F<debian/templates>. Note that any existing templates file will be
overwritten, and no backup will be kept. This file is created only if
F<debian/packages> contains any B<Templates:> field. The file might be used
with B<debconf-updatepo>(1) command of B<po-debconf>(7) system to regenerate
DebConf translations located in F<debian/po/> directory.
=item B<rebuild>
Regenerates all above required files if they don't exists already.
=back
=head1 FILES
=over 8
=item F<debian/packages>
contains package-specific information used in building both binary and
source packages
=item F<debian/changelog>
contains version-specific information about the package
=item F<debian/control>, F<debian/rules>, F<debian/templates>
generated automatically
=item F<debian/yada>
the script which controls building of the rules and control files, and which
is used by the rules file
=back
=head1 SEE ALSO
B<packages>(7)
=head1 DIAGNOSTICS
yada prints an error message and bails out with a non-zero exit code if it
detects an error.
=head1 BUGS
This is the kind of software which cannot be bug-free; different people will
want it to do different things. If you find a real bug, or you think a
feature should work differently, report it via the Debian bug tracking
system, and I'll do my best.
=head1 AUTHORS
(c) 1999 Charles Briscoe-Smith E<lt>cpbs@debian.orgE<gt>.
(c) 1999-2003 Piotr Roszatycki E<lt>dexter@debian.orgE<gt>.
|