synit
/
pmbootstrap
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

README: add line breaks 

Get rid of very long lines, break them at 80 characters except if there
is a link or command-line output that is longer.
This commit is contained in:
Oliver Smith 2022-10-25 21:58:04 +02:00
parent 7914c11d1c
commit 39d75445b5
No known key found for this signature in database
GPG Key ID: 5AE7F5513E0885CB
1 changed files with 28 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

42
README.md
View File

@ -1,17 +1,25 @@
# pmbootstrap # pmbootstrap
Sophisticated chroot/build/flash tool to develop and install [postmarketOS](https://postmarketos.org). Sophisticated chroot/build/flash tool to develop and install
[postmarketOS](https://postmarketos.org).
## Requirements ## Requirements
* Linux distribution on the host system (`x86`, `x86_64`, or `aarch64`) * Linux distribution on the host system (`x86`, `x86_64`, or `aarch64`)
* [Windows subsystem for Linux (WSL)](https://en.wikipedia.org/wiki/Windows_Subsystem_for_Linux) does **not** work! Please use [VirtualBox](https://www.virtualbox.org/) instead. * [Windows subsystem for Linux (WSL)](https://en.wikipedia.org/wiki/Windows_Subsystem_for_Linux)
does **not** work! Please use [VirtualBox](https://www.virtualbox.org/) instead.
* [Linux kernel 3.17 or higher](https://postmarketos.org/oldkernel) * [Linux kernel 3.17 or higher](https://postmarketos.org/oldkernel)
* Python 3.6+ * Python 3.6+
* OpenSSL * OpenSSL
* git * git
## Usage Examples ## Usage Examples
Please refer to the [postmarketOS wiki](https://wiki.postmarketos.org) for in-depth coverage of topics such as [porting to a new device](https://wiki.postmarketos.org/wiki/Porting_to_a_new_device) or [installation](https://wiki.postmarketos.org/wiki/Installation_guide). The help output (`pmbootstrap -h`) has detailed usage instructions for every command. Read on for some generic examples of what can be done with `pmbootstrap`. Please refer to the [postmarketOS wiki](https://wiki.postmarketos.org) for
in-depth coverage of topics such as
[porting to a new device](https://wiki.postmarketos.org/wiki/Porting_to_a_new_device)
or [installation](https://wiki.postmarketos.org/wiki/Installation_guide). The
help output (`pmbootstrap -h`) has detailed usage instructions for every
command. Read on for some generic examples of what can be done with
`pmbootstrap`.
### Installing pmbootstrap ### Installing pmbootstrap
<https://wiki.postmarketos.org/wiki/Installing_pmbootstrap> <https://wiki.postmarketos.org/wiki/Installing_pmbootstrap>
@ -75,7 +83,9 @@ $ pmbootstrap zap
``` ```
### Device Porting Assistance ### Device Porting Assistance
Analyze Android [`boot.img`](https://wiki.postmarketos.org/wiki/Glossary#boot.img) files (also works with recovery OS images like TWRP): Analyze Android
[`boot.img`](https://wiki.postmarketos.org/wiki/Glossary#boot.img) files (also
works with recovery OS images like TWRP):
``` ```
$ pmbootstrap bootimg_analyze ~/Downloads/twrp-3.2.1-0-fp2.img $ pmbootstrap bootimg_analyze ~/Downloads/twrp-3.2.1-0-fp2.img
``` ```
@ -139,12 +149,14 @@ List pmaports that don't have a binary package:
$ pmbootstrap repo_missing --arch=armhf --overview $ pmbootstrap repo_missing --arch=armhf --overview
``` ```
Increase the `pkgrel` for each aport where the binary package has outdated dependencies (e.g. after soname bumps): Increase the `pkgrel` for each aport where the binary package has outdated
dependencies (e.g. after soname bumps):
``` ```
$ pmbootstrap pkgrel_bump --auto $ pmbootstrap pkgrel_bump --auto
``` ```
Generate cross-compiler aports based on the latest version from Alpine's aports: Generate cross-compiler aports based on the latest version from Alpine's
aports:
``` ```
$ pmbootstrap aportgen binutils-armhf gcc-armhf $ pmbootstrap aportgen binutils-armhf gcc-armhf
``` ```
@ -194,18 +206,20 @@ $ pmbootstrap log_distccd
pmbootstrap supports `doas` and `sudo`. pmbootstrap supports `doas` and `sudo`.
If multiple sudo implementations are installed, pmbootstrap will use `doas`. If multiple sudo implementations are installed, pmbootstrap will use `doas`.
You can set the `PMB_SUDO` environmental variable to define the sudo implementation you want to use. You can set the `PMB_SUDO` environmental variable to define the sudo
implementation you want to use.
### Select SSH keys to include and make authorized in new images ### Select SSH keys to include and make authorized in new images
If the config file option `ssh_keys` is set to `True` (it defaults to `False`), then all files If the config file option `ssh_keys` is set to `True` (it defaults to `False`),
matching the glob `~/.ssh/id_*.pub` will be placed in `~/.ssh/authorized_keys` in the user's then all files matching the glob `~/.ssh/id_*.pub` will be placed in
home directory in newly-built images. `~/.ssh/authorized_keys` in the user's home directory in newly-built images.
Sometimes, for example if you have a large number of SSH keys, you may wish to select a Sometimes, for example if you have a large number of SSH keys, you may wish to
different set of public keys to include in an image. To do this, set the `ssh_key_glob` select a different set of public keys to include in an image. To do this, set
configuration parameter in the pmbootstrap config file to a string containing a glob that is to the `ssh_key_glob` configuration parameter in the pmbootstrap config file to a
match the file or files you wish to include. string containing a glob that is to match the file or files you wish to
include.
For example, a `~/.config/pmbootstrap.cfg` may contain: For example, a `~/.config/pmbootstrap.cfg` may contain: