commit 152cfc65daccf3ed64097f30af1848abb86485fe
parent 2ce1130421b517eac05514a7834c842b8d5f9182
Author: Friedel Schön <[email protected]>
Date: Tue, 6 Aug 2024 13:48:24 +0200
add manpage
Diffstat:
| D | readme.md | | | 83 | ------------------------------------------------------------------------------- |
| M | textselect.1 | | | 62 | ++++++++++++++++++++++++++++++++------------------------------ |
| M | textselect.c | | | 2 | +- |
3 files changed, 33 insertions(+), 114 deletions(-)
diff --git a/readme.md b/readme.md
@@ -1,83 +0,0 @@
-# weakbox
-
-**weakbox** is a tool for Linux designed to create a weak (not secured) container for running programs from another Linux distribution. It is particularly useful for executing glibc-based programs (mostly closed-source software) under systems that are musl-based.
-
-## Features
-
-- Create a container environment for running programs from different Linux distributions.
-- Bind mount directories from the host system into the container.
-- Map user and group IDs inside the container.
-- Customizable root path for the container.
-- Option to run commands within the container as `root`.
-
-## Installation
-
-To install **weakbox**, simply clone the repository and compile the source code:
-
-```bash
-git clone https://github.com/friedelschoen/weakbox.git
-cd weakbox
-make
-sudo make install # which installs /usr/bin/weakbox and /usr/share/man/man1/weakbox.1
-sudo make PREFIX=... install # which installs $PREFIX/bin/weakbox and $PREFIX/share/man/man1/weakbox.1
-```
-
-## Usage
-
-Run **weakbox** with the desired options and command to execute within the container:
-
-```bash
-weakbox [options] command ...
-```
-
-By default `command` is executed, if command is omitted current shell or `/bin/bash` is executed.
-
-### Options
-
-- `-h`: Display usage information.
-- `-s`: Run the specified command within the container as root.
-- `-v`: Enable verbose mode for debugging purposes.
-- `-r path`: Set the root path of the container to `path`. By default the container lays at `$WEAKBOX`.
-- `-b source[:target]`: Bind mount the specified source directory to the target directory within the container. Target is relative to `root`.
-- `-B source`: Remove a default bind mount from the container.
-- `-u uid[:uid]`: Map user IDs inside the container.
-- `-g gid[:gid]`: Map group IDs inside the container.
-
-### Default Mounts
-- `/dev`: directory containing all devices
-- `/home`: home directories of users
-- `/proc`: directories containing information about processes
-- `/sys`: system directories for various devices
-- `/tmp`: temporary directory
-- `/run`: temporary directory for daemons and long-running programs
-- `/etc/resolv.conf`: nameserver-resolution configuration
-- `/etc/passwd`: file containing information about users
-- `/etc/group`: file containing information about groups
-
-### Examples
-
-1. Run a program within the container:
-
-```bash
-weakbox -s /path/to/program
-```
-
-2. Create a container with custom root path and bind mount directories:
-
-```bash
-weakbox -r /custom/root -b /host/dir:/dir /path/to/program
-```
-
-3. Map user and group IDs inside the container:
-
-```bash
-weakbox -u 1000:1000 -g 1000:1000 /path/to/program
-```
-
-## Contributing
-
-Contributions are welcome! Feel free to submit bug reports, feature requests, or pull requests through GitHub issues and pull requests.
-
-## License
-
-This project is licensed under the zlib-license. See the [LICENSE](LICENSE) file for details.
diff --git a/textselect.1 b/textselect.1
@@ -1,58 +1,60 @@
-.TH TEXTSELECT 1 "August 2024" "1.0" "Text Selection Tool"
+.TH TEXTSELECT 1 "August 2024" "1.0" "Text Selection Utility"
.SH NAME
-textselect \- A command-line tool to mark and select lines from a text file using ncurses.
+textselect \- interactively select lines from a text file and optionally execute a command with the selected lines
.SH SYNOPSIS
.B textselect
-[\-v]
-.IR file
+.RI [ options ] " <input> [command [args...]]"
.SH DESCRIPTION
.B textselect
-is a command-line tool that allows users to interactively mark and select lines from a text file using ncurses. It displays the contents of a file, enables navigation through the lines, and allows lines to be marked. On exit, it prints the selected lines to the standard output.
+is a utility that allows users to interactively select lines from a text file using an ncurses interface. The selected lines can then be saved to an output file or passed as input to another command.
.SH OPTIONS
.TP
+.B \-h
+Display usage information and exit.
+.TP
.B \-v
-Invert the selection mode. When this option is used, lines that are not marked will be printed upon exit.
+Invert the selection of lines (selected lines become unselected and vice versa).
+.TP
+.B \-o \fIoutput\fP
+Specify an output file to save the selected lines. If not specified, the selected lines are printed to stdout.
.SH USAGE
-Navigate through the file using the arrow keys. Mark or unmark a line by pressing the spacebar. Exit the program by pressing 'q'.
+The program reads the input file line by line, displaying the lines in a scrollable ncurses window. Users can navigate through the lines and select or deselect lines using the keyboard.
-The program reads the specified file and displays its contents in an ncurses window. The following keys are used for navigation and selection:
+Navigation and selection keys:
+.TP
+.B KEY_UP
+Move the cursor up.
.TP
-.UP
-Move the cursor up by one line.
+.B KEY_DOWN
+Move the cursor down.
.TP
-.DOWN
-Move the cursor down by one line.
+.B v
+Invert the selection of lines.
.TP
-.SPACE
-Toggle the mark on the current line.
+.B SPACE
+Select or deselect the current line.
.TP
-.q
-Exit the program and print the marked lines.
+.B q
+Quit the selection interface.
+
+If a command and its arguments are specified, the selected lines are passed as input to the command. Otherwise, the selected lines are saved to the specified output file or printed to stdout.
.SH EXAMPLES
.TP
-Select lines from a file:
+Select lines from "input.txt" and save them to "output.txt":
.B
-textselect myfile.txt
+textselect \-o output.txt input.txt
.TP
-Invert the selection:
+Select lines from "input.txt" and pass them as input to the "sort" command:
.B
-textselect \-v myfile.txt
+textselect input.txt sort
.SH AUTHOR
-Written by [Your Name].
-
-.SH REPORTING BUGS
-Report bugs to <[email protected]>.
+Written by Your Name.
.SH COPYRIGHT
-This is free software: you are free to change and redistribute it. There is NO WARRANTY, to the extent permitted by law.
-
-.SH SEE ALSO
-.BR ncurses (3X),
-.BR vi (1),
-.BR less (1)
+This is free software; see the source for copying conditions. There is NO warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
diff --git a/textselect.c b/textselect.c
@@ -153,7 +153,7 @@ void output_chosen_lines(char *filename) {
* @param exitcode Exit code.
*/
NORETURN void usage(int exitcode) {
- fprintf(stderr, "Usage: %s [-hv] [-o output] <input>\n", argv0);
+ fprintf(stderr, "Usage: %s [-hv] [-o output] <input> [command ...]\n", argv0);
exit(exitcode);
}
