makeself.1 - megastep/makeself - Git at Google

 .TH "MAKESELF" "1" "2.7.1"
 .SH "NAME"
 makeself \- An utility to generate self-extractable archives.
 .SH "SYNTAX"
 .B makeself [\fIoptions\fP] archive_dir file_name label
 .B [\fIstartup_script\fP] [\fIargs\fP]
 .SH "DESCRIPTION"
 This program is a free (GPL) shell utility designed to create self-extractable
 compressed archives from a directory. The resulting file appears as a shell script, and can be launched as is. The archive
 will then uncompress itself to a temporary directory and an optional arbitrary
 command will be executed (for example an installation script).
 .TP
 Makeself archives also include checksums for integrity self-validation (CRC and/or MD5/SHA256 checksums).
 .SH "OPTIONS"
 The following options are supported:
 .TP 15
 .B -v, --version
 Prints out the makeself version number and exits.
 .TP
 .B -h, --help
 Print out help information.
 .TP
 .B --tar-quietly
 Suppress verbose output from the tar command
 .TP
 .B --quiet
 Do not print any messages other than errors
 .TP
 .B --gzip
 Compress using gzip (default if detected).
 .TP
 .B --bzip2
 Compress using bzip2.
 .TP
 .B --bzip3
 Compress using bzip3.
 .TP
 .B --pbzip2
 Compress using pbzip2.
 .TP
 .B --xz
 Compress using xz.
 .TP
 .B --lzo
 Compress using lzop.
 .TP
 .B --lz4
 Compress using lz4.
 .TP
 .B --pigz
 Compress using pigz.
 .TP
 .B --zstd
 Compress using zstd.
 .TP
 .B --base64
 Base64-encode the final compressed archive (base64 command required). This runs after compression and can be combined with any compressor.
 .TP
 .B --gpg-encrypt
 Encrypt the archive using GPG. This will prompt for a password to encrypt with.
 .TP
 .B --gpg-asymmetric-encrypt-sign
 Asymmetrically encrypt and sign the archive using GPG.
 .TP
 .B --gpg-extra opt
 Append more options to the gpg command line.
 .TP
 .B --ssl-encrypt
 Encrypt the archive using OpenSSL. This will prompt for a password to encrypt with.
 .TP
 .B --ssl-passwd pass
 Use the given password to encrypt the data using OpenSSL.
 .TP
 .B --ssl-pass-src src
 Use the given src as the source of password to encrypt the data using OpenSSL.
 .TP
 .B --ssl-no-md
 Do not use "-md" option (for older OpenSSL).
 .TP
 .B --keep-umask
 Keep the umask set to shell default, rather than overriding when executing the self-extracting archive.
 .TP
 .B --compress
 Compress using the UNIX 'compress' command.
 .TP
 .B --nocomp
 Do not compress the data.
 .TP
 .B --complevel lvl
 Specify the compression level for gzip, bzip2, pbzip2, xz, zstd, lzo or lz4. Defaults to 9.
 .TP
 .B --comp-extra opt
 Append more options to the compressor's command line.
 .TP
 .B --threads num
 Specify the number of threads to be used by compressors that support parallelization.
 .TP
 .B --tar-format opt
  Specify the tar archive format (default is ustar); you may use any value accepted by your tar command (such as posix, v7, etc).
 .TP
 .B --tar-extra opt
 Append more options to the tar command line.
 .TP
 .B --untar-extra opt
 Append more options when extracting the tar archive.
 .TP
 .B --notemp
 The archive will create archive_dir in the current directory and
 uncompress in ./archive_dir.
 .TP
 .B --copy
 Upon extraction, the archive will first copy itself to a temporary directory.
 .TP
 .B --append
 Append more files to an existing makeself archive. The label and startup scripts will then be ignored.
 .TP
 .B --current
 Files will be extracted to the current directory. Both --current and --target dir imply --notemp.
 .TP
 .B --target dir
 Extract directly to a target directory. Directory path can be either absolute or relative.
 .TP
 .B --header file
 Specify location of the header script.
 .TP
 .B --help-header file
 Add a header to the archive's help output.
 .TP
 .B --preextract file
 Specify a pre-extraction script.
 .TP
 .B --cleanup file
 Specify a cleanup script that executes on interrupt and when finished successfully.
 .TP
 .B --cleanup-args args
 Arguments to the cleanup script (wrap in quotes to provide multiple arguments).
 .TP
 .B --follow
 Follow the symlinks in the archive.
 .TP
 .B --noprogress
 Do not show the progress during the decompression.
 .TP
 .B --nooverwrite
 Do not extract the archive if the target directory already exists.
 .TP
 .B --nox11
 Disable automatic spawn of an xterm if running in X11.
 .TP
 .B --nowait
 Do not wait for user input after executing embedded program from an xterm.
 .TP
 .B --nochown
 Do not give the target folder to the current user.
 .TP
 .B --chown
 Give the target folder to the current user recursively.
 .TP
 .B --nomd5
 Do not create a MD5 checksum for the archive.
 .TP
 .B --sha256
 Adds a SHA256 checksum for the archive.
 .TP
 .B --nocrc
 Do not create a CRC32 checksum for the archive.
 .TP
 .B --lsm file
 LSM file describing the package.
 .TP
 .B --license file
 Append a license file.
 .TP
 .B --packaging-date date
 Use provided string as the packaging date instead of the current date.
 .TP
 .B --needroot
 Require root permissions for extraction.
 .TP
 .B --export-conf
 Export configuration variables to the startup script.
 .SH "ENVIRONMENT"
 .TP
 .B SETUP_NOCHECK
 If set to 1, then checksum validation will be skipped.
 .SH "EXAMPLES"
 Here is an example, assuming the user has a package image stored in a /home/joe/mysoft,
 and he wants to generate a self-extracting package named mysoft.sh, which will launch
 the "setup" script initially stored in /home/joe/mysoft:
 .TP
 makeself.sh /home/joe/mysoft mysoft.sh "Joe's Nice Software Package" ./setup
 .TP
 Here is also how I created the makeself.run archive which contains the Makeself distribution:
 .TP
 makeself.sh --notemp makeself makeself.run "Makeself by Stephane Peter" echo "Makeself has extracted itself"
 .SH "AUTHORS"
 Makeself has been written by Stephane Peter <megastep@megastep.org>.
 .BR
 This man page was originally written by Bartosz Fenski <fenio@o2.pl> for the
 Debian GNU/Linux distribution (but it may be used by others).
	.TH "MAKESELF" "1" "2.7.1"
	.SH "NAME"
	makeself \- An utility to generate self-extractable archives.
	.SH "SYNTAX"
	.B makeself [\fIoptions\fP] archive_dir file_name label
	.B [\fIstartup_script\fP] [\fIargs\fP]
	.SH "DESCRIPTION"
	This program is a free (GPL) shell utility designed to create self-extractable
	compressed archives from a directory. The resulting file appears as a shell script, and can be launched as is. The archive
	will then uncompress itself to a temporary directory and an optional arbitrary
	command will be executed (for example an installation script).
	.TP
	Makeself archives also include checksums for integrity self-validation (CRC and/or MD5/SHA256 checksums).
	.SH "OPTIONS"
	The following options are supported:
	.TP 15
	.B -v, --version
	Prints out the makeself version number and exits.
	.TP
	.B -h, --help
	Print out help information.
	.TP
	.B --tar-quietly
	Suppress verbose output from the tar command
	.TP
	.B --quiet
	Do not print any messages other than errors
	.TP
	.B --gzip
	Compress using gzip (default if detected).
	.TP
	.B --bzip2
	Compress using bzip2.
	.TP
	.B --bzip3
	Compress using bzip3.
	.TP
	.B --pbzip2
	Compress using pbzip2.
	.TP
	.B --xz
	Compress using xz.
	.TP
	.B --lzo
	Compress using lzop.
	.TP
	.B --lz4
	Compress using lz4.
	.TP
	.B --pigz
	Compress using pigz.
	.TP
	.B --zstd
	Compress using zstd.
	.TP
	.B --base64
	Base64-encode the final compressed archive (base64 command required). This runs after compression and can be combined with any compressor.
	.TP
	.B --gpg-encrypt
	Encrypt the archive using GPG. This will prompt for a password to encrypt with.
	.TP
	.B --gpg-asymmetric-encrypt-sign
	Asymmetrically encrypt and sign the archive using GPG.
	.TP
	.B --gpg-extra opt
	Append more options to the gpg command line.
	.TP
	.B --ssl-encrypt
	Encrypt the archive using OpenSSL. This will prompt for a password to encrypt with.
	.TP
	.B --ssl-passwd pass
	Use the given password to encrypt the data using OpenSSL.
	.TP
	.B --ssl-pass-src src
	Use the given src as the source of password to encrypt the data using OpenSSL.
	.TP
	.B --ssl-no-md
	Do not use "-md" option (for older OpenSSL).
	.TP
	.B --keep-umask
	Keep the umask set to shell default, rather than overriding when executing the self-extracting archive.
	.TP
	.B --compress
	Compress using the UNIX 'compress' command.
	.TP
	.B --nocomp
	Do not compress the data.
	.TP
	.B --complevel lvl
	Specify the compression level for gzip, bzip2, pbzip2, xz, zstd, lzo or lz4. Defaults to 9.
	.TP
	.B --comp-extra opt
	Append more options to the compressor's command line.
	.TP
	.B --threads num
	Specify the number of threads to be used by compressors that support parallelization.
	.TP
	.B --tar-format opt
	Specify the tar archive format (default is ustar); you may use any value accepted by your tar command (such as posix, v7, etc).
	.TP
	.B --tar-extra opt
	Append more options to the tar command line.
	.TP
	.B --untar-extra opt
	Append more options when extracting the tar archive.
	.TP
	.B --notemp
	The archive will create archive_dir in the current directory and
	uncompress in ./archive_dir.
	.TP
	.B --copy
	Upon extraction, the archive will first copy itself to a temporary directory.
	.TP
	.B --append
	Append more files to an existing makeself archive. The label and startup scripts will then be ignored.
	.TP
	.B --current
	Files will be extracted to the current directory. Both --current and --target dir imply --notemp.
	.TP
	.B --target dir
	Extract directly to a target directory. Directory path can be either absolute or relative.
	.TP
	.B --header file
	Specify location of the header script.
	.TP
	.B --help-header file
	Add a header to the archive's help output.
	.TP
	.B --preextract file
	Specify a pre-extraction script.
	.TP
	.B --cleanup file
	Specify a cleanup script that executes on interrupt and when finished successfully.
	.TP
	.B --cleanup-args args
	Arguments to the cleanup script (wrap in quotes to provide multiple arguments).
	.TP
	.B --follow
	Follow the symlinks in the archive.
	.TP
	.B --noprogress
	Do not show the progress during the decompression.
	.TP
	.B --nooverwrite
	Do not extract the archive if the target directory already exists.
	.TP
	.B --nox11
	Disable automatic spawn of an xterm if running in X11.
	.TP
	.B --nowait
	Do not wait for user input after executing embedded program from an xterm.
	.TP
	.B --nochown
	Do not give the target folder to the current user.
	.TP
	.B --chown
	Give the target folder to the current user recursively.
	.TP
	.B --nomd5
	Do not create a MD5 checksum for the archive.
	.TP
	.B --sha256
	Adds a SHA256 checksum for the archive.
	.TP
	.B --nocrc
	Do not create a CRC32 checksum for the archive.
	.TP
	.B --lsm file
	LSM file describing the package.
	.TP
	.B --license file
	Append a license file.
	.TP
	.B --packaging-date date
	Use provided string as the packaging date instead of the current date.
	.TP
	.B --needroot
	Require root permissions for extraction.
	.TP
	.B --export-conf
	Export configuration variables to the startup script.
	.SH "ENVIRONMENT"
	.TP
	.B SETUP_NOCHECK
	If set to 1, then checksum validation will be skipped.
	.SH "EXAMPLES"
	Here is an example, assuming the user has a package image stored in a /home/joe/mysoft,
	and he wants to generate a self-extracting package named mysoft.sh, which will launch
	the "setup" script initially stored in /home/joe/mysoft:
	.TP
	makeself.sh /home/joe/mysoft mysoft.sh "Joe's Nice Software Package" ./setup
	.TP
	Here is also how I created the makeself.run archive which contains the Makeself distribution:
	.TP
	makeself.sh --notemp makeself makeself.run "Makeself by Stephane Peter" echo "Makeself has extracted itself"
	.SH "AUTHORS"
	Makeself has been written by Stephane Peter <megastep@megastep.org>.
	.BR
	This man page was originally written by Bartosz Fenski <fenio@o2.pl> for the
	Debian GNU/Linux distribution (but it may be used by others).