2012-03-05 02:32 Guido Günther <a...@sigxcpu.org>:
|
| POD would be o.k. I'll handle the docbook conversion.
| Cheers,

Attached is the initial manual page

Thanks,
Jari

#   Copyright
#
#       Copyright (C) 2012 Jari Aalto
#
#   License
#
#       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
#       MERCHANTABILITY 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, see <http://www.gnu.org/licenses/>.
#
#   Description
#
#       To learn what TOP LEVEL sections to use in manual pages,
#       see POSIX/Susv standard and "Utility Description Defaults" at
#       
http://www.opengroup.org/onlinepubs/009695399/utilities/xcu_chap01.html#tag_01_11
#
#       This is manual page in Perl POD format. Read more at
#       http://perldoc.perl.org/perlpod.html or run command:
#
#           perldoc perlpod | less
#
#       To check the syntax:
#
#           podchecker *.pod
#
#       Create manual page with command:
#
#           pod2man PAGE.N.pod > PAGE.N

=pod

=head1 NAME

gbp.conf - git-buildpackage configuration file

=head1 SYNOPSIS

    /etc/git-buildpackage/gbp.conf      system wide
    ~/gbp.conf                          per user
    .gbp.conf                           per branch
    debian/gbp.conf                     per branch, alternative location
    .git/gbp.conf                       per repository

=head1 DESCRIPTION

The I<gbp.conf> provides default global options and specific options
for git-buildpackage commands. The generic file syntax is:

    [GLOBAL]
    # This is section for global settings. Affects all commands
    key = value

    [<command>]
    # Specific sections for each COMMAND, like git-buildpackage
    key = value

In I<key=value> pairs of the COMMAND sections reflect the command line
options and their settings. For example git-buildpackage(1) manual
page contains option:

    --git-export-dir=directory

Which can be tuned into configuration file setting by dropping the
C<--git> prefix with:

    [git-buildpackage]
    export-dir  = directory

Notice that some option are actually repeatable, or take Python lists.
For example git-import-orig(1) commmand has option:

    --filter=pattern
        filter  out  files  glob-matching pattern. Can be given multiple
        times.

To repeat that opion in configuration file, use:

    [git-import-orig]
    filter = .svn
    filter = .hg

An alternative way is to write it using Python list syntax:

    [git-import-orig]
    filter = [ '.svn', '.hg' ]

=head1 EXAMPLES

An example set up for packaging work:

    # $HOME/gbp.conf

    [DEFAULT]
    pristine-tar = True
    cleaner = fakeroot debian/rules clean
    # builder = debuild -i\.git -I.git -us -uc

    [git-buildpackage]
    export-dir  = ../build-area/
    # tarball-dir = ../tarballs/
    # pbuilder = True
    # dist = testing

    [git-import-orig]
    dch = False
    filter = .svn
    filter = .hg
    filter = .bzr
    filter = CVS
    filter = debian/*
    filter = */debian/*
    filter-pristine-tar = True

    [git-import-dsc]
    filter = [
           'CVS',
           '.cvsignore',
           '.hg',
           '.hgignore'
           '.bzr',
           '.bzrignore',
           '.gitignore'
           ]

    # End of file

=head1 ENVIRONMENT

None.

=head1 FILES

See See /etc/git-buildpackage/gbp.conf for an example.

=head1 STANDARDS

The Git-Buildpackage Manual at
/usr/share/doc/git-buildpackage/manual-html/index.html

=head1 AVAILABILITY

=head1 SEE ALSO

git-import-dsc(1)
git-import-dscs(1)
git-import-orig(1)
git-dch(1),
git-pbuilder(1)
debuild(1)
git(1)
pristine-tar(1)

=head1 AUTHORS

Program was written by <f...@example.com>

This manual page was written by Jari Aalto <jari.aa...@cante.net>.
Released under license GNU GPL version 2 or (at your option) any later
version. For more information about license, visit
<http://www.gnu.org/copyleft/gpl.html>.

=cut

Reply via email to