mirror of
https://github.com/erenfro/gen2stage4.git
synced 2024-09-21 11:02:53 -04:00
102 lines
3.8 KiB
Markdown
102 lines
3.8 KiB
Markdown
|
|
|
|
# mkstage4
|
|
|
|
This is a Bash script to create stage 4 tarballs either for the running system, or a system at a specified mount point.
|
|
The script was inspired by an earlier [mkstage4 script](https://github.com/gregf/bin/blob/master/mkstage4) by Greg Fitzgerald (unmaintained as of 2012) which itself was a revamped edition of the [original mkstage4](http://blinkeye.ch/dokuwiki/doku.php/projects/mkstage4) by Reto Glauser (unmaintaied as of 2009).
|
|
|
|
More information on mkstage4 can be found on the following blogs, though instructions may be outdated compared to the current version, best documented by this `README` file:
|
|
|
|
* English: [mkstage4 - Stage 4 Tarballs Made Easy](http://tutorials.chymera.eu/blog/2014/05/18/mkstage4-stage4-tarballs-made-easy/).
|
|
* Chinese: [中文说明](http://liuk.io/blog/gentoo-stage4)
|
|
|
|
## Installation
|
|
|
|
The script can be run directly from its containing folder (and thus, is installed simply by downloading or cloning it from here - and adding run permissions):
|
|
|
|
```bash
|
|
git clone https://github.com/TheChymera/mkstage4.git /your/mkstage4/directory
|
|
cd /your/mkstage4/directory
|
|
chmod +x mkstage4.sh
|
|
```
|
|
|
|
For [Gentoo Linux](http://en.wikipedia.org/wiki/Gentoo_linux) and [Derivatives](http://en.wikipedia.org/wiki/Category:Gentoo_Linux_derivatives), mkstage4 is also available in [Portage](http://en.wikipedia.org/wiki/Portage_(software)) via the base Gentoo overlay.
|
|
On any Gentoo system, just run the following command:
|
|
|
|
```
|
|
emerge app-backup/mkstage4
|
|
```
|
|
|
|
## Usage
|
|
|
|
*If you are running the script from the containing folder (first install method) please make sure you use the `./mkstage4.sh` command instead of just `mkstage4`!*
|
|
|
|
Archive your current system (mounted at /):
|
|
|
|
```bash
|
|
mkstage4 -s archive_name
|
|
```
|
|
|
|
Archive a system located at a custom mount point:
|
|
|
|
```bash
|
|
mkstage4 -t /custom/mount/point archive_name
|
|
```
|
|
|
|
Command line arguments:
|
|
|
|
```
|
|
mkstage4.sh [-q -c -b -l -k -p] [-s || -t <target-mountpoint>] [-e <additional excludes dir*>] <archive-filename> [custom-tar-options]
|
|
-q: activates quiet mode (no confirmation).
|
|
-c: excludes connman network lists.
|
|
-b: excludes boot directory.
|
|
-l: excludes lost+found directory.
|
|
-p: compresses parallelly using pbzip2.
|
|
-e: an additional excludes directory (one dir one -e).
|
|
-s: makes tarball of current system.
|
|
-k: separately save current kernel modules and src (smaller & save decompression time).
|
|
-t: makes tarball of system located at the <target-mountpoint>.
|
|
-h: displays help message.
|
|
```
|
|
|
|
## Extract Tarball
|
|
|
|
Tarballs created with mkstage4 can be extracted with:
|
|
|
|
```bash
|
|
tar xvjpf archive_name.tar.bz2
|
|
```
|
|
|
|
To preserve binary attributes and use numeric owner identifiers (considered good practice on Gentoo), you can simply append the relevant flags to the respective `tar` commands, e.g.:
|
|
|
|
```bash
|
|
tar xvjpf archive_name.tar.bz2 --xattrs-include='*.*' --numeric-owner
|
|
```
|
|
|
|
If you use the `-k` option, extract `src` and the modules separately:
|
|
|
|
```bash
|
|
tar xvjpf archive_name.tar.bz2.kmod
|
|
tar xvjpf archive_name.tar.bz2.ksrc
|
|
```
|
|
|
|
If you have pbzip2 installed, you can extract using parallelization, with:
|
|
|
|
```bash
|
|
tar -I pbzip2 -xvf archive_name.tar.bz2
|
|
```
|
|
|
|
## Dependencies
|
|
|
|
* **[Bash](https://en.wikipedia.org/wiki/Bash_(Unix_shell))** - in [Portage](http://en.wikipedia.org/wiki/Portage_(software)) as **app-shells/bash**
|
|
* **[tar](https://en.wikipedia.org/wiki/Tar_(computing))** - in Portage as **app-arch/tar**
|
|
|
|
*Please note that these are very basic dependencies and should already be included in any Linux system. Additionally, the scrip can use:*
|
|
|
|
* **[pbzip2](https://launchpad.net/pbzip2)** (optional, if it is installed the archive can be compressed using multiple parallel threads) - in Portage as
|
|
**app-arch/pbzip2**
|
|
|
|
|
|
---
|
|
Released under the GPLv3 license.
|
|
Project led by Horea Christian (address all correspondence to: chr@chymera.eu).
|