notcurses/doc/man/man1/tfman.1.md

65 lines
1.6 KiB
Markdown
Raw Normal View History

% tfman(1)
2021-12-04 10:30:57 -05:00
% nick black <nickblack@linux.com>
2022-12-10 05:20:23 -05:00
% v3.0.9
2021-12-04 10:30:57 -05:00
# NAME
tfman - Swank manual page browser
2021-12-04 10:30:57 -05:00
# SYNOPSIS
**tfman** [**-h**] [**-V**] [**-q**] files
2021-12-04 10:30:57 -05:00
# DESCRIPTION
**tfman** displays manual pages ala **man(1)** using the Notcurses
2021-12-04 10:30:57 -05:00
(**notcurses(3)**) terminal UI library.
# OPTIONS
**-V**: Print the program name and version, and exit with success.
**-h**: Print help information, and exit with success.
**-q**: Don't wait for any input, and don't use the alternate screen.
2021-12-04 10:30:57 -05:00
files: Files to render.
2021-12-15 01:55:47 -05:00
If successfully loaded and parsed, the top of the page will be visible.
In the lower right corner is a listing of page sections. By default, the
page browser is in use; press Tab to move between the page browser and
the structure browser. Press 's' to toggle the structure browser's
visibility.
**tfman** can identify gzipped manual pages, and inflate them on the fly.
# NOTES
The following keypresses are recognized:
* **Ctrl-L**: Redraw the screen.
* **q**: Quit.
* **k**/**up**: Move up by one line.
* **b**/**pgup**: Move up by one page.
* **h**/**left**: Move up by one section.
* **j**/**down**: Move down by one line.
* **f**/**pgdown**: Move down by one page.
* **l**/**right**: Move down by one section.
2022-05-25 22:31:48 +05:00
* **g**/**home**: Go to first line in file.
2021-12-15 01:55:47 -05:00
* **s**: Toggle the structure browser's visibility.
2021-12-15 01:55:47 -05:00
The mouse wheel can also be used to move up and down within the active browser.
2021-12-04 10:30:57 -05:00
# BUGS
2021-12-12 04:15:06 -05:00
**tfman** does not currently (and is unlikely to ever) support the full
**groff** macro language.
2021-12-04 10:30:57 -05:00
# SEE ALSO
**man(1)**,
**notcurses(3)**,
2021-12-04 13:16:46 -05:00
**groff_man(7)**,
2021-12-04 10:30:57 -05:00
**man-pages(7)**,
**unicode(7)**