.\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.29.
.TH "SRC2PKG" "1" "February 2010" "src2pkg\-2.4" "User Commands"
.SH "NAME"
src2pkg \- manual page for src2pkg\-2.4
.SH "DESCRIPTION"
src2pkg \- Builds an installable package from a source archive
or from other installable content.
.TP
src2pkg [-h(--help), -hh(--more-help), --version, --list]
.TP 
src2pkg [User Options] [Build Options]  file\-name
.TP 
src2pkg \-[ABCDHINOPRSTUV(VV)WX] \-[abcdefimnpsuv] file\-name
.SH "EXTENDED OPTIONS"
\-E \-LANG \-[DEST,JAIL,REAL,SAFE,UNION] \-[DEB,PET,PET2,TAZ,TBZ,TGZ,TLZ,TXZ,Z1,Z2,Z3,Z4]
\-[ACF,ACN] \-LOG \-BUMP -\CWD \-\-resume=funcname \-\-pause=[before|after|funcname]
\-[M32,M64] \-\-machine=?? \-\-jobs=?? \-[L32,L64] \-\-libdirsuffix=??
.IP 
Capitalized 
.B User Options 
take no argument:
.TP 
\fB\-A\fR
Autogenerate a src2pkg script when and if the build succeeds.
.TP 
\fB\-B\fR
Keep backup of any files overwritten by this installation.
.TP
\fB\-C\fR
Place finished package in Current directory.
.TP
\fB\-CWD\fR
Use the current directory for all build locations.
.TP
\fB\-D\fR
Don't apply diff or patch files automatically.
.TP
\fB\-H\fR
Place finished package in your HOME directory.
.TP
\fB\-I\fR
Install the created package when finished.
.TP 
\fB\-N\fR
Generate a starting src2pkg script and description file only.
.TP 
\fB\-O\fR
Use an OBJECT directory for building (USE_OBJ_DIR='YES').
.TP 
\fB\-P\fR
Preserve permissions in the source directory. (CORRECT_PERMS='NO')
.TP
\fb\-Q\fR
Query the user for interactive options during configuration and package creation.
.TP 
\fB\-R\fR
Replay errors in configuration or compilation(useful in QUIET mode).
.TP
\fB\-S\fR
Use a Shell script for installation(install.sh by default)
.TP 
\fB\-T\fR
Test\-build the source code without attempting to make a package.
.TP
\fB\-U\fR
Update the build script for compatibility if needed.
.TP
\fB\-V\fR
DEBUG -show detailed prompts for debugging.
.TP 
\fB\-VV\fR
Be verbose. Show all output from the steps (QUIET='NO').
.TP 
\fB\-W\fR
Remove (wipe out) temporary build files (CLEANUP=ALL).
.TP
\fB\-X\fR
Execute a build script in the current working directory.
.IP 
The following 
.B Build Options 
require an argument separated by the '=' sign. Use single '' or double "" quotes around the 
arguments if they contain spaces.
.TP 
\fB\-a\fR
Set the architecture of the package [\-a=noarch] (ARCH='').
.TP 
\fB\-b\fR
Set the build or release number [\-b=2] (BUILD='').
.TP 
\fB\-c\fR
Set the CONFIG_COMMAND option \-usually 'configure'.
.TP 
\fB\-d\fR
Set the list of douments to include [\-d='README AUTHORS'] (DOCLIST='').
.TP 
\fB\-e\fR
Pass extra arguments to configure [\-e='\-\-disable\-gnome'] (EXTRA_CONFIGS='').
.TP 
\fB\-f\fR
Set the CFLAGS variable [\-f='\-Wall \fB\-O3\fR'] (STD_FLAGS='').
.TP 
\fB\-i\fR
Set the install command line [\-i='make install'] (INSTALL_LINE).
.TP 
\fB\-m\fR
Set the 'make' command [\-m='make dep all'] (MAKE_COMMAND).
.TP 
\fB\-n\fR
Set the package name [\-n='newname'] (ALT_NAME='').
.TP 
\fB\-p\fR
Set the installation prefix [\-p=/usr] (PRE_FIX='').
.TP 
\fB\-s\fR
Set the configuration subdir [\-s=src] (CONFIG_SUBDIR='').
.TP 
\fB\-u\fR
Set the URL location of the source tarball.
.TP 
\fB\-v\fR
Set the version of the package [\-v=0.0.0a] (ALT_VERSION='').
.TP
.B Note: 
Variables shown above in parenthesis are the src2pkg script equivalents.
.IP
.B Special Options:
.TP
\fB\-h\fR
(\-\-help) Show the help message and then exit.
.TP
\fB\-hh\fR
(\-\-more\-help) Show the Advanced Options and then exit.
.TP
\fB\-v\fR
(--version) Show the src2pkg version and then exit.
.TP
\fB\-\-setup\fR
This special option compiles the binaries and libraries needed by src2pkg.
Usually you only need to do this when you first install src2pkg or if you
upgrade src2pkg and the new version uses a new version of these programs.
This command must be run as 'root' since it eventually creates and installs
a package of the resulting libraries and binaries -called src2pkg-helpers-X.X.??
.TP
\fB\-\-list\fR
Show a list of the src2pkg instruction functions (for use with \-\-resume= or \-\-pause= option)
.IP
.B Extended Options:
.TP
\fB\-LOG\fR
Log the output from 'configure', 'make' and 'make install' to a file.
.TP 
\fB\-BUMP\fR
Increment the BUILD number and write the change to the build script.
.TP 
\fB\-CHECK\fR
Verify the build using 'make check' (or command set with -t/--test_command).
.TP
\fB\-ACF\fR
Use configuration options from *.spec or rules files, if found.
.TP
\fB\-ACN\fR
Use standard configuration options found in configure script.
.B INSTALL_TYPE
.TP
\fB\-DEST\fR
Run installation commands using the DESTDIR variable if possible.
.TP
\fB\-JAIL\fR
Run installation commands in a 'jailed' root directory.
.TP
\fB\-REAL\fR
Run installation commands in the real root filesystem using backup(root only).
.TP
\fB\-SAFE\fR
Run installation commands in a SAFE mode(root only). (Implies the \-REAL option)
.TP
\fB\-UNION\fR
Run installation commands using a unionfs/chroot, if available(root only).
.TP
\fB\-\-pause=(before|after)\fR
(before|after) Pause before or after running each function.
.TP
\fB\-\-pause=funcname\fR
Pause before and after the named function('src2pkg --list' to see options).
.TP
\fB\-\-resume=funcname\fR
Resume a build starting at the named instruction function. 
Run 'src2pkg --list' to see a list of the named functions.
.TP
\fB\-\-cc=??\fR Set the CC variable to choose the C compiler to use.
.TP
\fB\-\-cxx=??\fR Set the CXX variable to choose the C++ compiler to use.
.TP
\fB\-\-convert\fR Convert/translate a Slackbuild script into a src2pkg script(long form).
.TP
\fB\-\-convert\-simple\fR Convert/translate a Slackbuild script into a src2pkg script using a short form if possible.
.TP
\fB\-\-splitpkg\fR Create separate 'devel', 'i18n', 'docs' and/or 'solibs' packages.
.TP
\fB\-t\fR or \fB\-\-test_command\fR
Set the test command (implies -CHECK). [-t='make check']
.TP
\fB\-E\fR
Create and use extended database files (slack-required and slack-supplies).
.TP
\fB\--jobs=??\fR
Set the number of concurrent 'jobs' to be run by the 'make' program. 
(ex: --jobs=5 passes '-J5' to 'make' program)
.TP
\fB\-LANG\fR
Delete extra language files (man-pages, locale and i18n) files.
.br
Be sure to configure /etc/src2pkg/DONT_PURGE.locales file first.
.TP
\fB\-L(32/64)\fR
Set the LIBDIRSUFFIX variable to adjust installation paths for multilib systems.
.br
Set to -LNULL(or L0 or -Lnull), if needed, to use no suffix in the installation paths.
.TP
\fB\-\-libdirsuffix=??\fR
As above, but use this syntax if setting to anything besides 32, 64 or NULL.
.TP
\fB\-M(32/64)\fR
Set the '-m'(machine_option) variable to gcc, to use the selected compiler. This
is used to create 32-bit libs/programs for 64-bit systems (using -M32).
.TP
\fB\-\-machine=??\fR
As above, but use this syntax for any options besides 32 or 64.
.TP
\fB\-DEB\fR
Create the final package as a debian *.deb archive.
.TP
\fB\-PET\fR
Create the final package as a '.pet' archive.
.TP
\fB\-PET2\fR
Create the final package as a '.pet' archive for 'woof'.
.TP
\fB\-RPM\fR
Create the final package as an '.rpm' archive.
.TP
\fB\-TAZ\fR
Create the final package as a slitaz '.tazpkg' archive.
.TP
\fB\-TBZ\fR
Use bzip2 to compress the final package.
.TP
\fB\-TGZ\fR
Use gzip to compress the final package (this is the default).
.TP
\fB\-TLZ\fR
Use lzma to compress the final package.
.TP
\fB\-TXZ\fR
Use xz to compress the final package.
.TP
\fB\-UPX\fR
Use upx-ucl or upx to compress binaries inside the package.
.TP
\fB\-EPX\fR
Use exepak to compress binaries inside the package.
.TP
\fB\-Z?\fR
SAVE_SPACE=? Squeeze packages by using more compression:
.br
The 'Z' options are cumulative - Z4 does all of Z1, Z2 and Z3.
.TP
\fB\-Z1\fR
Z1 Use bzip2 instead of gzip for man-pages.
.TP
\fB\-Z2\fR
Z2 Compresses ELF binaries using upx or upx-ucl if present.
.TP
\fB\-Z3\fR
Z3 Link to a common copy of the GPL in /usr/share/licences.
.TP
\fB\-Z4\fR
Z4 Archive the package doc directory and remove 'info' files.
.SH "EXAMPLES"
.IP
src2pkg myprogram\-0.1.tar.bz2
.IP 
src2pkg \-N myprogram\-0.1.tar.bz2
.IP 
src2pkg \-i='make install install\-data'\fB\-A\fR myprogram\-0.1.tar.bz2
.IP 
src2pkg \-e='\-\-disable\-nls' \fB\-A\fR myprogram\-0.1.tar.bz2
.SH "USAGE"
.IP
When given the name of a compressed source tarball
.B  src2pkg
performs all the commands necessary to unpack and compile 
the sources and then install them using the command 
\'make install\', tracking whatever directories, files or 
links are created and then making a Slackware\-type
tgz package from those files, etc.
.IP
.B src2pkg
will execute its' own scripts if one is named instead of a tarball,
or the command 'src2pkg \-X' will search the current directory and run
the first *.scrpkg.auto or *.src2pkg script it finds.
.IP
Giving a valid URL to a source tarball or *.src2pkg script online will
automatically download the archive or script for you if you are connected
to the internet and then build the package.
.IP
The options 
.B \-ACF
and
.B \-ACN
are used to allow src2pkg to try to find options automatically and pass them 
to the configure script. The 
.B \-ACF
option tells 
.B src2pkg
to look for options in an RPM *.spec file or debian 'rules' file, if either one
is present inside the sources. The
.B \-ACN
option tells 
.B src2pkg
to detect common standard options in the configure script itself. If present, they
will assigned default values and used to configure the sources. The list of possible
options which will be searched for can be configured in the 
.B /etc/src2pkg/src2pkg.conf
file by setting the 
.B AUTO_CONFIG_OPTIONS
variable.
.SH "SEE ALSO"
The full documentation for
.B  src2pkg
is maintained as part of the
.B  src2pkg
package.
.LP  
.B  See /usr/doc/src2pkg\\-x.x for further usage.
.PP