mirror of
https://github.com/megastep/makeself.git
synced 2025-11-03 01:33:43 +08:00
Updated man page (fixes #260)
This commit is contained in:
57
makeself.1
57
makeself.1
@@ -1,14 +1,18 @@
|
||||
.TH "MAKESELF" "1" "2.4.5"
|
||||
.TH "MAKESELF" "1" "2.5.0"
|
||||
.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) utility designed to create self-extractable
|
||||
archives from a directory.
|
||||
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.
|
||||
The following options are supported:
|
||||
.TP 15
|
||||
.B -v, --version
|
||||
Prints out the makeself version number and exits.
|
||||
@@ -40,6 +44,24 @@ Compress using lzop.
|
||||
.B --lz4
|
||||
Compress using lz4.
|
||||
.TP
|
||||
.B --pigz
|
||||
Compress using pigz.
|
||||
.TP
|
||||
.B --zstd
|
||||
Compress using zstd.
|
||||
.TP
|
||||
.B --base64
|
||||
Encode the archive to ASCII in Base64 format instead of compressing (base64 command required).
|
||||
.TP
|
||||
.B --gpg-encrypt
|
||||
Encrypt the archive using GPG. This will prompt for a password to encrypt with.
|
||||
.TP
|
||||
.B --ssl-encrypt
|
||||
Encrypt the archive using OpenSSL. This will prompt for a password to encrypt with.
|
||||
.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
|
||||
@@ -47,7 +69,16 @@ Compress using the UNIX 'compress' command.
|
||||
Do not compress the data.
|
||||
.TP
|
||||
.B --complevel lvl
|
||||
Specify the compression level for gzip,bzip2,pbzui2,xz,lzo or lz4
|
||||
Specify the compression level for gzip, bzip2, pbzip2, xz, zstd, lzo or lz4. Defaults to 9.
|
||||
.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 --notemp
|
||||
The archive will create archive_dir in the current directory and
|
||||
@@ -68,6 +99,9 @@ Extract directly to a target directory. Directory path can be either absolute or
|
||||
.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 --cleanup file
|
||||
Specify a cleanup script that executes on interrupt and when finished successfully.
|
||||
.TP
|
||||
@@ -77,6 +111,9 @@ Follow the symlinks in the archive.
|
||||
.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
|
||||
@@ -86,13 +123,21 @@ Do not wait for user input after executing embedded program from an xterm.
|
||||
.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
|
||||
.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
|
||||
@@ -104,7 +149,7 @@ Here is also how I created the makeself.run archive which contains the Makeself
|
||||
.TP
|
||||
makeself.sh --notemp makeself makeself.run "Makeself by Stephane Peter" echo "Makeself has extracted itself"
|
||||
.SH "AUTHORS"
|
||||
Makeself has been written by Stéphane Peter <megastep@megastep.org>.
|
||||
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).
|
||||
|
||||
Reference in New Issue
Block a user