-
Notifications
You must be signed in to change notification settings - Fork 11
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #22 from antavelos/manpage
Add manpage
- Loading branch information
Showing
1 changed file
with
76 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,76 @@ | ||
| .\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.47.3. | ||
| .TH TERMINEWS "1" "January 2021" "User Commands" | ||
| .SH NAME | ||
| terminews \- terminal based (TUI) RSS feed manager | ||
| .SH SYNOPSIS | ||
| .B terminews | ||
| .SH DESCRIPTION | ||
| .\" Add any additional description here | ||
| .PP | ||
| Terminal based application (TUI) which enables managing of RSS resources and displying their news feed. | ||
| .PP | ||
| The terminal is split in 3 different areas: | ||
| .TP | ||
| \fBSites list\fR | ||
| contains the list of the user's saved sites. | ||
| .TP | ||
| \fBNews list\fR | ||
| contains the news feed (list of news' titles) of the currently selected site. | ||
| .TP | ||
| \fBSummary\fR | ||
| contains extra information of the currently selected event. | ||
| .SS "Key bindings:" | ||
| .TP | ||
| \fBTab\fR | ||
| Focuses between the Sites list and the News list alternately | ||
| .TP | ||
| \fBEnter\fR | ||
| Retrieves the news feed of the currently selected site or submits user input | ||
| .TP | ||
| \fBCtrl o\fR | ||
| Downloads the content of the currently selected event. | ||
| .TP | ||
| \fBCtrl Alt o\fR | ||
| Opens the currently selected event using the default browser | ||
| .TP | ||
| \fBCtrl n\fR | ||
| Prompts the user to add a new site (URL) | ||
| .TP | ||
| \fBCtrl f\fR | ||
| Prompts the user to search among the existing sites. Multiple terms are allowed and they are used conjunctively | ||
| .TP | ||
| \fBCtrl q\fR | ||
| Closes any window (input prompt, event content) displayed on top of the main windows | ||
| .TP | ||
| \fBCtrl b\fR | ||
| Adds or removes the currently selected event in the bookmarks list | ||
| .TP | ||
| \fBCtrl Alt b\fR | ||
| Displays the bookmarked events | ||
| .TP | ||
| \fBDel\fR | ||
| Deletes the selected site of the selected bookmarked event depending on which list is currently focused | ||
| .TP | ||
| \fB↑\fR | ||
| Moves to the previous list item circularly | ||
| .TP | ||
| \fB↓\fR | ||
| Moves to the next list item circularly | ||
| .TP | ||
| \fBPgUp\fR | ||
| Moves to the previous list page circularly | ||
| .TP | ||
| \fBPgDn\fR | ||
| Moves to the next list page circularly | ||
| .TP | ||
| \fBCtrl h\fR | ||
| Opens up the Help window | ||
| .TP | ||
| \fBCtrl c\fR | ||
| Exits the application | ||
| .SH AUTHOR | ||
| Written by Alex Ntavelos <[email protected]> | ||
| .SH "REPORTING BUGS" | ||
| https://github.com/antavelos/terminews/issues | ||
| .SH "SEE ALSO" | ||
| https://github.com/antavelos/terminews |