Add Docs to new Features

Signed-off-by: Hadi Chokr <hadichokr@icloud.com>
This commit is contained in:
Hadi Chokr 2025-07-12 21:36:55 +02:00
parent 1dad3c86fe
commit cc714d6af7
2 changed files with 110 additions and 0 deletions

51
doc/toolbox-export.1.md Normal file
View File

@ -0,0 +1,51 @@
# toolbox-export(1)
## NAME
toolbox-export - Export binaries or applications from a toolbox container to your host
## SYNOPSIS
**toolbox export** [--bin _binary_] [--app _application_] --container _container_
## DESCRIPTION
The **toolbox export** command allows you to expose binaries or desktop applications from a toolbox container onto your host system. This is achieved by creating wrapper scripts for binaries in `~/.local/bin` and desktop files for applications in `~/.local/share/applications`. These exported items let you launch containerized tools seamlessly from your host environment.
## OPTIONS
**--bin _binary_**
: Export a binary from the toolbox container. The argument can be a binary name or a path inside the container.
**--app _application_**
: Export a desktop application from the toolbox container. This will search for an appropriate `.desktop` file inside the container and adapt it for host use.
**--container _container_**
: Name of the toolbox container from which the binary or application should be exported.
## EXAMPLES
Export the `vim` binary from the container named `arch`:
```
toolbox export --bin vim --container arch
```
Export the `firefox` application from the container named `fedora`:
```
toolbox export --app firefox --container fedora
```
## FILES
Exported binaries are placed in:
```
~/.local/bin/
```
Exported desktop files are placed in:
```
~/.local/share/applications/
```
## SEE ALSO
toolbox(1), toolbox-unexport(1)
## AUTHORS
Toolbox contributors

59
doc/toolbox-unexport.1.md Normal file
View File

@ -0,0 +1,59 @@
# toolbox-unexport(1)
## NAME
toolbox-unexport - Remove exported binaries and applications for a toolbox container
## SYNOPSIS
**toolbox unexport** --container _container_ [--bin _binary_] [--app _application_] [--all]
## DESCRIPTION
The **toolbox unexport** command removes exported binaries and/or desktop applications that were previously made available on the host from a specified toolbox container. This helps clean up your host from wrappers and desktop files created by the `toolbox export` command.
## OPTIONS
**--bin _binary_**
: Remove the exported binary wrapper for the specified binary, for the given container.
**--app _application_**
: Remove the exported desktop application for the specified app, for the given container.
**--all**
: Remove all exported binaries and applications for the specified container.
**--container _container_**
: The container whose exported binaries and applications should be removed.
## EXAMPLES
Remove the exported `vim` binary for container `arch`:
```
toolbox unexport --container arch --bin vim
```
Remove the exported `firefox` application for container `fedora`:
```
toolbox unexport --container fedora --app firefox
```
Remove all exported binaries and applications for container `arch`:
```
toolbox unexport --container arch --all
```
## FILES
Exported binaries are located in:
```
~/.local/bin/
```
Exported desktop files are located in:
```
~/.local/share/applications/
```
## SEE ALSO
toolbox(1), toolbox-export(1)
## AUTHORS
Toolbox contributors