Skip to content

Commit 4a2624e

Browse files
docs: update readme with help messages
1 parent e26b66d commit 4a2624e

File tree

1 file changed

+56
-4
lines changed

1 file changed

+56
-4
lines changed

README.md

Lines changed: 56 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -37,17 +37,69 @@ udroid -i impish:mate
3737
udroid -i focal:xfce4
3838
```
3939

40-
### login (`-l`)
40+
###### help
41+
42+
```cmd
43+
udroid [ install| --install ] [<options>] [<suite>]:[<varient>]
44+
installs udroid distros
45+
options:
46+
-h, --help show this help message and exit
47+
--no-verify-integrity do not verify integrity of filesystem
48+
49+
example:
50+
udroid install jammy:raw
51+
udroid install --install jammy:raw
52+
```
53+
54+
### login (`login`)
4155

4256
```bash
43-
udroid -l udroid-jammy-raw
57+
udroid --login jammy:raw
58+
# or
59+
udroid login jammy:raw # same as above
60+
```
61+
62+
###### help
63+
```cmd
64+
udroid [ login| --login ] [<options>] <suite>:<varient> <cmd>
65+
login to a suite
66+
67+
options:
68+
-h, --help: show this help message and exit
69+
--user: Allows the user to specify the login user for the filesystem.
70+
--name: Allows the user to specify a custom name for the filesystem to install
71+
--bind or -b: Allows the user to specify extra mount points for the filesystem.
72+
--isolated: Creates an isolated environment for the filesystem.
73+
--fix-low-ports: Fixes low ports for the filesystem.
74+
--no-shared-tmp: Disables shared tmp for the filesystem.
75+
--no-link2symlink: Disables link2symlink for the filesystem.
76+
--no-sysvipc: Disables sysvipc for the filesystem.
77+
--no-fake-root-id: Disables fake root id for the filesystem.
78+
--no-kill-on-exit: Disables kill on exit for the filesystem.
79+
80+
<cmd>:
81+
command to run in the filesystem and exit
4482
```
4583

4684
> WIP
4785
48-
### remove (`-r`)
86+
### remove (`remove`)
4987

50-
> WIP
88+
```bash
89+
udroid remove jammy:raw
90+
```
91+
92+
###### help
93+
94+
```cmd
95+
udroid [ remove| --remove ] <distro>
96+
removes udroid distros
97+
example:
98+
udroid remove jammy:raw
99+
udroid remove --remove jammy:raw
100+
```
101+
102+
> Download cache is ignored
51103
52104
## Contributing
53105

0 commit comments

Comments
 (0)