weakbox.1 (3080B) download
1.TH WEAKBOX 1 "April 2024" "Version 0.1.0" "User Manuals"
2
3.SH NAME
4weakbox \- create a weak container for running programs from a different Linux distribution
5
6.SH SYNOPSIS
7.B weakbox
8[\-hs] [\fI\-r\fP path] [\fI\-b\fP source[:target]] [\fI\-B\fP source] [\fI\-u\fP uid[:uid]] [\fI\-g\fP gid[:gid]] [command] ...
9
10.SH DESCRIPTION
11\fBweakbox\fR is a tool for Linux that allows you to create a container environment suitable for running programs from a different Linux distribution, particularly useful for executing glibc-based programs (mostly closed-source software) under systems that are musl-based. The container created by \fBweakbox\fR is not secured and should not be considered as a secure isolation mechanism.
12By default \fBcommand\fR is executed, if command is omitted current shell or \fI/bin/sh\fR is executed.
13
14.SH OPTIONS
15.TP
16\fB\-h\fP
17Display usage information and exit.
18.TP
19\fB\-s\fP
20Run the specified command within the container as \fIroot\fR.
21.TP
22\fB\-v\fP
23Enable verbose mode for debugging purposes.
24.TP
25\fB\-r\fP path
26Use a different root path of the container than \fBWEAKBOX\fR.
27.TP
28\fB\-b\fP source[:target]
29Bind mount the specified source directory to the target directory within the container. If \fItarget\fR is not provided, it defaults to the same as \fIsource\fR. \fItarget\fR is relative to container-root.
30.TP
31\fB\-B\fP source
32Remove the specified bind mount from the \fIdefault bindings\fR.
33.TP
34\fB\-u\fP uid[:uid]
35Map user IDs inside the container. If only one \fIuid\fR is provided, it will be mapped to the same ID inside the container.
36.TP
37\fB\-g\fP gid[:gid]
38Map group IDs inside the container. If only one \fIgid\fR is provided, it will be mapped to the same ID inside the container.
39
40.SH EXAMPLES
41.TP
421. Run a program within the container:
43.B weakbox -s /path/to/program
44.TP
452. Create a container with a custom root path and bind mount directories:
46.B weakbox -r /custom/root -b /host/dir:/dir /path/to/program
47.TP
483. Map user and group IDs inside the container:
49.B weakbox -u 1000:1000 -g 1000:1000 /path/to/program
50
51.SH ENVIRONMENT VARIABLES
52\fBWEAKBOX\fR
53Set the root path of the container if not provided via the \fI\-r\fR option.
54
55.SH DEFAULT MOUNTS
56.TP
57\fI/dev\fR
58directory containing all devices
59.TP
60\fI/home\fR
61home directories of users
62.TP
63\fI/proc\fR
64directories containing information about processes
65.TP
66\fI/sys\fR
67system directories for various devices
68.TP
69\fI/tmp\fR
70temporary directory
71.TP
72\fI/run\fR
73temporary directory for daemons and long-running programs
74.TP
75\fI/etc/resolv.conf\fR
76nameserver-resolution configuration
77.TP
78\fI/etc/passwd\fR
79file containing information about users
80.TP
81\fI/etc/group\fR
82file containing information about groups
83
84.SH EXIT STATUS
85.TP
860
87Successful execution.
88.TP
891
90An error occurred during execution.
91
92.SH SEE ALSO
93For more information, refer to the \fBweakbox\fR source code or documentation.
94
95.SH AUTHOR
96\fBweakbox\fR was written by Friedel Schon.
97
98.SH REPORTING BUGS
99Report bugs to the GitHub repository for \fBweakbox\fR.
100
101.SH COPYRIGHT
102\fBweakbox\fR is licensed under the zlib-license.