Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
sylirre committed Dec 10, 2023
1 parent edf58d8 commit 261e856
Showing 1 changed file with 42 additions and 0 deletions.
42 changes: 42 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -68,6 +68,8 @@ cd proot-distro
Dependencies: bash, bzip2, coreutils, curl, findutils, gzip, ncurses-utils,
proot, sed, tar, xz-utils

If you want command line auto complete, install the `bash-completion` package.

## Functionality overview

PRoot Distro aims to provide all-in-one functionality for managing the
Expand All @@ -93,6 +95,24 @@ Example of installing the distribution:
proot-distro install debian
```

Some commands support aliases. For example, instead of
```
proot-distro list
proot-distro install debian
proot-distro login debian
proot-distro remove debian
```

you can type this:
```
proot-distro ls
proot-distro i debian
proot-distro sh debian
proot-distro rm debian
```

Information about supported aliases can be viewed in help for each command.

Known distributions are defined through plug-in scripts, which define URLs
from where root file system archive will be downloaded and set of checksums
for integrity check. Plug-ins also can define a set of commands which would
Expand All @@ -113,6 +133,8 @@ This command will show the help information about `proot-distro` usage.

Command: `backup`

Aliases: `bak`, `bkp`

Backup specified distribution and its plug-in into tar archive. The contents
of backup can be either printed to stdout for further processing or written
to a file.
Expand All @@ -134,6 +156,8 @@ done by user through external commands.*

Command: `install`

Aliases: `add`, `i`, `in`, `ins`

Install a distribution specified by alias - a short name referring to the
plug-in of chosen distribution.

Expand All @@ -160,13 +184,17 @@ in directory with others (`$PREFIX/etc/proot-distro`).

Command: `list`

Aliases: `li`, `ls`

Shows a list of available distributions, their aliases, installation status
and comments.

### Start shell session

Command: `login`

Aliases: `sh`

Execute a shell within the given distribution. Example:
```
proot-distro login debian
Expand Down Expand Up @@ -250,10 +278,16 @@ Login command supports these behavior modifying options:
Do not kill processes when shell session terminates. Typically will cause
session to hang if you have any background processes running.

* `--kernel`

Set the kernel release and compatibility level to given value.

### Uninstall distribution

Command: `remove`

Aliases: `rm`

This command completely deletes the installation of given system. Be careful
as it does not ask for confirmation. Deleted data is irrecoverably lost.

Expand All @@ -266,6 +300,8 @@ proot-distro remove debian

Command: `rename`

Aliases: `mv`

Rename the distribution by changing the alias name, renaming its plug-in and
root file system directory. In case when default distribution is being renamed,
a copy of plug-in will be created.
Expand All @@ -281,6 +317,8 @@ Only installed distribution can be renamed.

Command: `reset`

Aliases: \-

Delete the specified distribution and install it again. This is a shortcut for
```
proot-distro remove <dist> && proot-distro install <dist>
Expand All @@ -297,6 +335,8 @@ Same as with command `remove`, deleted data is lost irrecoverably. Be careful.

Command: `restore`

Aliases: \-

Restore the distribution from the given proot-distro backup (tar archive).

Restore operation performs a complete rollback to the backup state as was in
Expand All @@ -315,6 +355,8 @@ proot-distro restore ./pd-debian-backup.tar.xz

Command: `clear-cache`

Aliases: `clear`, `cl`

This will remove all cached root file system archives.

## Adding distribution
Expand Down

0 comments on commit 261e856

Please sign in to comment.