diff options
| author | Bruce Hill <bruce@bruce-hill.com> | 2019-05-22 00:43:25 -0700 |
|---|---|---|
| committer | Bruce Hill <bruce@bruce-hill.com> | 2019-05-22 00:43:25 -0700 |
| commit | fe73058f840b4deeeda7a72d10b625bb90f6b026 (patch) | |
| tree | dff6f3a8062958290d3768a17c6e859fe0fadc63 | |
| parent | 075525603907717663e22f424d40ac6a74b806db (diff) | |
Added manpage
| -rw-r--r-- | Makefile | 2 | ||||
| -rw-r--r-- | bb.1 | 61 |
2 files changed, 62 insertions, 1 deletions
@@ -25,7 +25,7 @@ install: $(NAME) fi; \ mkdir -pv $$prefix/bin $$prefix/share/man/man1 \ && cp -v $(NAME) $$prefix/bin/ \ - && cp -v doc/$(NAME).1 $$prefix/share/man/man1/ + && cp -v $(NAME).1 $$prefix/share/man/man1/ uninstall: @prefix="$(PREFIX)"; \ @@ -0,0 +1,61 @@ +.\" Manpage for bb. +.\" Contact bruce@bruce-hill.com to correct errors or typos. +.TH man 8 "22 May 2019" "1.0" "bb man page" +.SH NAME +bb \- A bitty browser for command line file management +.SH SYNOPSIS +.B bb +[\fI-d\fR] +[\fI-s\fR] +[\fIdirectory\fR] +.SH DESCRIPTION +\fBbb\fR is a tiny TUI console application for browsing and managing files. +.SH OPTIONS +.B \-d +Print the current directory on exit. + +.B \-s +Print the selected files on exit. + +.B directory +Open to this directory. + +.SH CONTROLS +For full details on all key bindings, press \fB?\fR from inside \fBbb\fR to get +a help menu. + +.TP +.B Navigating: +Arrow keys or h/j/k/l can be used to navigate. + +.TP +.B Selecting: +\fBSpace\fR is used to toggle file selection. Actions (such as copying or +deleting files) are performed on the selected files. If no files are selected, +actions are performed on the file under the cursor. The selection can be +cleared by pressing \fBEscape\fR. + +.TP +.B Mouse: +Clicking on a file will select it. Double clicking will open it. Clicking on +the far left character of a file's row will toggle selection of that file. + +.SH EXAMPLES +.TP +.B +bb /usr/local/ +Begin browsing in /usr/local/ + +.TP +.B +bb -s | xargs zip archive.zip +Select some files to add to a zip archive. + +.TP +.B +alias bb="cd '`/usr/local/bin/bb -d || pwd`'" +Create an alias to launch \fBbb\fR and change directory to wherever it's located +when you exit (unless you exit with Ctrl-c). + +.SH AUTHOR +Bruce Hill (bruce@bruce-hill.com) |