[Date Prev][Date Next] [Thread Prev][Thread Next] [Date Index] [Thread Index]

Bug#96501: Man page for build-fastforward



Package: fastforward-src
Tag: patch

--
Tomas Kuliavas
.TH build-fastforward 1

.SH NAME
build-fastforward \- helper script for building fastforward binary package

.SH SYNOPSIS
.B build-fastforward
.br

.SH DESCRIPTION
.PP
\fBbuild-fastforward\fP script prompts user to enter all
the necessary parameters, builds and installs (if user says so) 
\fBfastforward\fP package. It can be run by root or non-root user.
.PP
If script is run by root, it asks about:
.IP \fB*\fP
temporary directory used for unpacking program sources and 
building \fBfastforward\fP package. Default is \fI/tmp/fastforward\fP.
User must have write access to this directory. If directory doesn't
exist, user must have write access to the directory above. 

If directory exists, script will ask permission to use this directory.
Default option is \fIN\fP (no, don't use existing directory). Other
option is \fIy\fP (use existing directory and override the files 
that reside in that directory).
.IP \fB*\fP
permission to build the package. It's enough to press \fIENTER\fP
.IP \fB*\fP 
if binary package is created during build process, script 
asks user's permission to remove all files except binary package 
in directory used for building package. Default is \fIY\fP (yes).
Other option is \fIn\fP (no, don't cleanup directory). 
.IP \fB*\fP 
user's permission to install \fBfastforward\fP package. Default is
\fIY\fP (yes, install). Other option is \fIn\fP (no, don't install)
.IP \fB*\fP 
user's permission to remove \fBfastforward-src\fP package. Default 
is \fIN\fP (no, don't remove). Other option is \fIy\fP (yes, remove
source package).

.PP
If script is run by non-root user, additional questions about
\fBfakeroot\fP or \fBsudo\fP usage are asked.
.PP
Non-root user can build package only if \fBfakeroot\fP is installed
or if this user can use \fBsudo\fP to gain root user privileges.
.PP
Non-root user can install builded binary package only if \fBsudo\fP 
is installed and if this user can use \fBsudo\fP to gain root privileges.

.SH SEE ALSO
For more information about \fBfastforward\fP see:
.br
http://cr.yp.to/fastforward.html

.SH LICENSE
This script is licensed under the GPL

.SH AUTHOR
Script was originally written by Philip Hands <phil@hands.com>
.PP
This manual page was written by Tomas Kuliavas 
<tokul@bigfoot.com> for the Debian GNU/Linux system, 
but may be used elsewhere under the GPL.



















Reply to: