Skip to content

Commit eca1fe8

Browse files
committed
Documentation updates
1 parent 6774043 commit eca1fe8

File tree

2 files changed

+8
-5
lines changed

2 files changed

+8
-5
lines changed

README.md

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ will then uncompress itself to a temporary directory and an optional arbitrary
1010
command will be executed (for example an installation script). This is pretty
1111
similar to archives generated with WinZip Self-Extractor in the Windows world.
1212
Makeself archives also include checksums for integrity self-validation (CRC
13-
and/or MD5 checksums).
13+
and/or MD5/SHA256 checksums).
1414

1515
The makeself.sh script itself is used only to create the archives from a
1616
directory of files. The resultant archive is actually a compressed (using
@@ -98,6 +98,7 @@ makeself.sh [args] archive_dir file_name label startup_script [script_args]
9898
* **`--nox11`** : Disable the automatic spawning of a new terminal in X11.
9999
* **`--nowait`** : When executed from a new X11 terminal, disable the user prompt at the end of the script execution.
100100
* **`--nomd5`** and **`--nocrc`** : Disable the creation of a MD5 / CRC checksum for the archive. This speeds up the extraction process if integrity checking is not necessary.
101+
* **`--sha256`** : Adds a SHA256 checksum for the archive. This is in addition to the MD5 / CRC checksums unless `--nomd5` is also used.
101102
* **`--lsm` _file_** : Provide and LSM file to makeself, that will be embedded in the generated archive. LSM files are describing a software package in a way that is easily parseable. The LSM entry can then be later retrieved using the `--lsm` argument to the archive. An example of a LSM file is provided with Makeself.
102103
* **`--tar-extra opt`** : Append more options to the tar command line.
103104

@@ -111,7 +112,7 @@ makeself.sh [args] archive_dir file_name label startup_script [script_args]
111112
* **`--help-header file`** : Add a header to the archive's `--help` output.
112113
* `archive_dir` is the name of the directory that contains the files to be archived
113114
* `file_name` is the name of the archive to be created
114-
* `label` is an arbitrary text string describing the package. It will be displayed while extracting the files.
115+
* `label` is an arbitrary text string describing the package. It will be displayed while extracting the files.
115116
* `startup_script` is the command to be executed _from within_ the directory of extracted files. Thus, if you wish to execute a program contain in this directory, you must prefix your command with `./`. For example, `./program` will be fine. The `script_args` are additionnal arguments for this command.
116117

117118
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
@@ -122,7 +123,7 @@ Here is an example, assuming the user has a package image stored in a **/home/jo
122123

123124
Here is also how I created the [makeself.run][9] archive which contains the Makeself distribution :
124125

125-
`makeself.sh --notemp makeself makeself.run "Makeself by Stephane Peter" echo "Makeself has extracted itself" `
126+
`makeself.sh --notemp makeself makeself.run "Makeself by Stephane Peter" echo "Makeself has extracted itself" `
126127

127128
Archives generated with Makeself can be passed the following arguments:
128129

@@ -167,7 +168,7 @@ I will gladly consider merging your pull requests on the [GitHub][10] repository
167168

168169
## Download
169170

170-
Get the latest official distribution [here][9] (version 2.3.1).
171+
Get the latest official distribution [here][9] (version 2.4.0).
171172

172173
The latest development version can be grabbed from [GitHub][10]. Feel free to submit any patches there through the fork and pull request process.
173174

@@ -191,6 +192,7 @@ The latest development version can be grabbed from [GitHub][10]. Feel free to su
191192
* **v2.2.0:** First major new release in years! Includes many bugfixes and user contributions. Please look at the [project page on Github][10] for all the details.
192193
* **v2.3.0:** Support for archive encryption via GPG or OpenSSL. Added LZO and LZ4 compression support. Options to set the packaging date and stop the umask from being overriden. Optionally ignore check for available disk space when extracting. New option to check for root permissions before extracting.
193194
* **v2.3.1:** Various compatibility updates. Added unit tests for Travis CI in the GitHub repo. New `--tar-extra`, `--untar-extra`, `--gpg-extra`, `--gpg-asymmetric-encrypt-sign` options.
195+
* **v2.4.0:** Added optional support for SHA256 archive integrity checksums.
194196

195197
## Links
196198

@@ -219,7 +221,7 @@ This project is now hosted on GitHub. Feel free to submit patches and bug report
219221
[6]: http://earth.google.com/
220222
[7]: http://www.virtualbox.org/
221223
[8]: http://www.gnu.org/copyleft/gpl.html
222-
[9]: https://github.com/megastep/makeself/releases/download/release-2.3.1/makeself-2.3.1.run
224+
[9]: https://github.com/megastep/makeself/releases/download/release-2.4.0/makeself-2.4.0.run
223225
[10]: https://github.com/megastep/makeself
224226
[11]: https://github.com/megastep/loki_setup/
225227
[12]: http://www.unrealtournament2003.com/

makeself.sh

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -67,6 +67,7 @@
6767
# Added --target dir to allow extracting directly to a target directory (Guy Baconniere)
6868
# - 2.2.0 : Many bugfixes, updates and contributions from users. Check out the project page on Github for the details.
6969
# - 2.3.0 : Option to specify packaging date to enable byte-for-byte reproducibility. (Marc Pawlowsky)
70+
# - 2.4.0 : Optional support for SHA256 checksums in archives.
7071
#
7172
# (C) 1998-2018 by Stephane Peter <[email protected]>
7273
#

0 commit comments

Comments
 (0)