xaizek / pinfo (License: GPLv2 only) (since 2018-12-07)
Console-based info and manual pages reader, which adds interactive navigation to man pages.
Clone URLs: https://code.reversed.top/user/xaizek/pinfo ssh://rocketgit@code.reversed.top/user/xaizek/pinfo
0.6.10 add-ax-check-compile-flag cxx glib master
Commit e62ddb06ab495d827c91acd76e805ac5ec297712

port of r270: spelling fixes in man page
git-svn-id: svn://svn.debian.org/svn/pinfo/pinfo/branches/cxx@271 ea4b0d59-4df7-0310-a9f9-bf8cbe41ce66
Author: bas
Author date (UTC): 2005-11-14 14:54
Committer name: bas
Committer date (UTC): 2005-11-14 14:54
Parent(s): 2ac117b02b62b23e842aab78df65e8ffec0046c2
Signing key:
Tree: 07b9866706a35cc338bf649366f1ed5b3ff64db7
File Lines added Lines deleted
doc/pinfo.1.in 27 27
File doc/pinfo.1.in changed (mode: 100644) (index 8663c80..69569dd)
... ... The program will then (by default) search for it in
17 17 .IR "/usr/share/info", .IR "/usr/share/info",
18 18 and and
19 19 .IR "/usr/local/info". .IR "/usr/local/info".
20 The searchpath can be adjusted by INFOPATH environment variable or in config
21 file. Pinfo will also automaticaly add the suffix '-info', '-info.Z', '-info.gz', or '-info.bz2'.
20 The search path can be adjusted by INFOPATH environment variable or in the configuration
21 file. Pinfo will also automatically add the suffix '-info', '-info.Z', '-info.gz', or '-info.bz2'.
22 22 At present other suffixes are not recognized, but you can easily add them to At present other suffixes are not recognized, but you can easily add them to
23 23 the function the function
24 24 .I openinfo() .I openinfo()
 
... ... Supported options are
48 48 manual pager). \fBWarning\fR: Everything what follows this option is passed manual pager). \fBWarning\fR: Everything what follows this option is passed
49 49 to the `\fIman\fR' program. Don't be confused if pinfo options, which to the `\fIman\fR' program. Don't be confused if pinfo options, which
50 50 followed `\fB-m\fR' don't work. When using this option, pinfo does not parse followed `\fB-m\fR' don't work. When using this option, pinfo does not parse
51 the info options as ussual! It invokes the man part of program.
51 the info options as usual! It invokes the man part of program.
52 52 .P .P
53 53 You can also call the man function of pinfo in another way. When pinfo is You can also call the man function of pinfo in another way. When pinfo is
54 54 called with an argv[0] (the program file name), which contains the word 'man' called with an argv[0] (the program file name), which contains the word 'man'
 
... ... headers. Use with care. ;)
78 78 .P .P
79 79 .BR "-s", .BR "-s",
80 80 .BR "--squeeze-lines" \- .BR "--squeeze-lines" \-
81 cut empty lines from manual pages. This option enables autocutting of every
81 cut empty lines from manual pages. This option enables auto cutting of every
82 82 repeated newline in a manual page. repeated newline in a manual page.
83 83 .P .P
84 84 .BR "-t", .BR "-t",
85 85 .BR "--force-manual-tag-table" \- .BR "--force-manual-tag-table" \-
86 86 forces manual detection of tag table. This allows you to view info pages, forces manual detection of tag table. This allows you to view info pages,
87 87 which may be corrupted. (as i.e. version of jed's pages, shipped with which may be corrupted. (as i.e. version of jed's pages, shipped with
88 RH5.0). The tag table corruption ussualy appears in that the info links,
88 RH5.0). The tag table corruption usually appears in that the info links,
89 89 which you follow, move you to quite unexpected nodes. which you follow, move you to quite unexpected nodes.
90 90 .P .P
91 91 .BR "--node=\fInodename\fB", .BR "--node=\fInodename\fB",
92 92 .BR "--node \fInodename\fB" \- .BR "--node \fInodename\fB" \-
93 93 Go to the node `\fInodename\fR' of info file. Since 0.6.7 it is also Go to the node `\fInodename\fR' of info file. Since 0.6.7 it is also
94 possible to specify nodes as in standalone info via filenames, like
94 possible to specify nodes as in standalone info via file names, like
95 95 `(gcc)Introduction'. `(gcc)Introduction'.
96 96 .P .P
97 97 .BR "--rcfile=\fIfilename\fB", .BR "--rcfile=\fIfilename\fB",
98 98 .BR "--rcfile \fIfilename\fB" \- .BR "--rcfile \fIfilename\fB" \-
99 Use alternate rcfile.
99 Use alternate configuration file.
100 100 .P .P
101 101 .BR "--long-manual-links", .BR "--long-manual-links",
102 102 .BR "-l" \- .BR "-l" \-
 
... ... Warning! If you do not have getopt, these options will not work!
117 117 .P .P
118 118 .SH DEFAULT KEYS WHEN BROWSING INFO FILE .SH DEFAULT KEYS WHEN BROWSING INFO FILE
119 119 .P .P
120 Just take a look at the example config file (below), and at the key
120 Just take a look at the example configuration file (below), and at the key
121 121 descriptions. Keys available in manual viewer differ a bit from the keys descriptions. Keys available in manual viewer differ a bit from the keys
122 122 available in info viewer. available in info viewer.
123 123 .P .P
 
... ... Here's an example of such a file; we'll discuss the contents below:
139 139 .P .P
140 140 .nf .nf
141 141 .sp .sp
142 # Here are some colour setting.
142 # Here are some color setting.
143 143 # Whitespace between the entries is optional. # Whitespace between the entries is optional.
144 144 COL_NORMAL = COLOR_WHITE, COLOR_BLACK, NO_BOLD, NO_BLINK COL_NORMAL = COLOR_WHITE, COLOR_BLACK, NO_BOLD, NO_BLINK
145 145 COL_MENUSELECTED = COLOR_RED, COLOR_BLACK, BOLD, NO_BLINK COL_MENUSELECTED = COLOR_RED, COLOR_BLACK, BOLD, NO_BLINK
 
... ... names are present in the example, and they're self explanatory, I
232 232 think. There is also a special color COLOR_DEFAULT, which stands for think. There is also a special color COLOR_DEFAULT, which stands for
233 233 transparency). Then you enter the foreground color, and the background transparency). Then you enter the foreground color, and the background
234 234 color. The BOLD attribute means that we want the foreground color to color. The BOLD attribute means that we want the foreground color to
235 be highlighted. (i.e. lightblue, lightgreen). BLINK attribute is the
235 be highlighted. (i.e. light blue, light green). BLINK attribute is the
236 236 blinking attribute, or highlighted background in some other configurations. blinking attribute, or highlighted background in some other configurations.
237 237 .P .P
238 238 Now let's move to the key definitions. Here we first put a key name (again Now let's move to the key definitions. Here we first put a key name (again
 
... ... code name if it's a special key (like i.e. in KEY_FOLLOWLINK_1).
243 243 .P .P
244 244 If you wish to specify key by code value, use the supplied program 'testkey' If you wish to specify key by code value, use the supplied program 'testkey'
245 245 to obtain the needed value. It mainly is a feature, when you want to add to obtain the needed value. It mainly is a feature, when you want to add
246 some ctrl+letter keybindings, and similar.
246 some CTRL+letter keybindings, and similar.
247 247 .P .P
248 248 For each function you can bind two keys, i.e. you could bind both For each function you can bind two keys, i.e. you could bind both
249 249 Enter and Cursor Right to the FollowLink-function. As you can see in Enter and Cursor Right to the FollowLink-function. As you can see in
 
... ... Key for repeating the last search.
273 273 Alternate key for repeating the last search. Alternate key for repeating the last search.
274 274 .TP .TP
275 275 .B KEY_GOTO_1 .B KEY_GOTO_1
276 Key for explicitly going to a node (by specifing it's name).
276 Key for explicitly going to a node (by specifying it's name).
277 277 .TP .TP
278 278 .B KEY_GOTO_2 .B KEY_GOTO_2
279 Alternate key for explicitly going to a node (by specifing it's name).
279 Alternate key for explicitly going to a node (by specifying it's name).
280 280 .TP .TP
281 281 .B KEY_PREVNODE_1 .B KEY_PREVNODE_1
282 Key for going to a node marked as 'Prev' in the header. In manpage viewer
282 Key for going to a node marked as 'Prev' in the header. In man page viewer
283 283 this goes to the previous man section. this goes to the previous man section.
284 284 .TP .TP
285 285 .B KEY_PREVNODE_2 .B KEY_PREVNODE_2
286 Alternate key for going to a node marked as 'Prev' in the header. In manpage
287 viewer this goest to the previous man section.
286 Alternate key for going to a node marked as 'Prev' in the header. In man page
287 viewer this goes to the previous man section.
288 288 .TP .TP
289 289 .B KEY_NEXTNODE_1 .B KEY_NEXTNODE_1
290 Key for going to a node marked as 'Next' in the header. In manpage viewer
290 Key for going to a node marked as 'Next' in the header. In man page viewer
291 291 this goes to the next man section. this goes to the next man section.
292 292 .TP .TP
293 293 .B KEY_NEXTNODE_2 .B KEY_NEXTNODE_2
294 Alternate key for going to a node marked as 'Next' in the header. In manpage
294 Alternate key for going to a node marked as 'Next' in the header. In man page
295 295 viewer this goes to the next man section. viewer this goes to the next man section.
296 296 .TP .TP
297 297 .B KEY_UP_1 .B KEY_UP_1
 
... ... Key for following a hypertext link.
365 365 Alternate key for following a hypertext link. Alternate key for following a hypertext link.
366 366 .TP .TP
367 367 .B KEY_REFRESH_1 .B KEY_REFRESH_1
368 Key for refreshing the screen (hardcoded is the ^L value).
368 Key for refreshing the screen (hard coded is the ^L value).
369 369 .TP .TP
370 370 .B KEY_REFRESH_2 .B KEY_REFRESH_2
371 371 Alternate key for refreshing the screen. Alternate key for refreshing the screen.
 
... ... The special mnemonics for keys (which are defined at present) are:
422 422 .TP .TP
423 423 .B KEY_PPAGE .B KEY_PPAGE
424 424 .TP .TP
425 .BR KEY_END " [Note: this works probably \fBONLY\fR with linux ncurses]"
425 .BR KEY_END " [Note: this works probably \fBONLY\fR with Linux ncurses]"
426 426 .TP .TP
427 427 .B KEY_F(x) .B KEY_F(x)
428 428 .TP .TP
 
... ... C/C++ ;).
441 441 .TP .TP
442 442 .B [number] .B [number]
443 443 \- you can also specify key as it's code number. It is useful e.g. when \- you can also specify key as it's code number. It is useful e.g. when
444 specifing control keys, and some nonstandard keys.
445 A numerical value of zero turns given keybinding off.
444 specifying control keys, and some nonstandard keys.
445 A numerical value of zero turns given key binding off.
446 446 .sp .sp
447 447 .RE .RE
448 448 See manual page for curs_getch (3x) for description of their meaning. See manual page for curs_getch (3x) for description of their meaning.
449 449 .P .P
450 Warning! Try not to create some serious keybinding conflicts!
450 Warning! Try not to create some serious key binding conflicts!
451 451 .P .P
452 452 The options in the last part of the example configuration file should The options in the last part of the example configuration file should
453 453 be fairly self-explanatory. The variables that can be set to true or be fairly self-explanatory. The variables that can be set to true or
454 false do the same things as the commandline arguments with the same
454 false do the same things as the command line arguments with the same
455 455 names. names.
456 456 .RS .RS
457 457 .sp .sp
 
... ... Set this to the program you want to use to follow ftp links in
497 497 documents. documents.
498 498 .TP .TP
499 499 .B MAILEDITOR .B MAILEDITOR
500 Set this to your favourite email program, and it will be started if
500 Set this to your favorite email program, and it will be started if
501 501 you follow an email link in a document. you follow an email link in a document.
502 502 .TP .TP
503 503 .B PRINTUTILITY .B PRINTUTILITY
 
... ... manpage), Xlib function pages match section 3X11, etc. Such extensions may
512 512 not be recognized by default, so it is a good idea to add them). not be recognized by default, so it is a good idea to add them).
513 513 .TP .TP
514 514 .B INFOPATH .B INFOPATH
515 This allows you to override the default searchpath for info pages. The paths
515 This allows you to override the default search path for info pages. The paths
516 516 should be separated by colons. should be separated by colons.
517 517 .TP .TP
518 518 .B MAN-OPTIONS .B MAN-OPTIONS
 
... ... This specifies the options, which should be passed to the `man' program.
520 520 (see man(1) for description of what they're like). (see man(1) for description of what they're like).
521 521 .TP .TP
522 522 .B STDERR-REDIRECTION .B STDERR-REDIRECTION
523 Pinfo allows you to redirect the stderr output of called programms. For
523 Pinfo allows you to redirect the stderr output of called programs. For
524 524 example if you don't want to see man's error messages about manual page example if you don't want to see man's error messages about manual page
525 525 formatting, you can use \fISTDER-REDIRECTION="2> /dev/null". This is the formatting, you can use \fISTDER-REDIRECTION="2> /dev/null". This is the
526 526 default. default.
Hints
Before first commit, do not forget to setup your git environment:
git config --global user.name "your_name_here"
git config --global user.email "your@email_here"

Clone this repository using HTTP(S):
git clone https://code.reversed.top/user/xaizek/pinfo

Clone this repository using ssh (do not forget to upload a key first):
git clone ssh://rocketgit@code.reversed.top/user/xaizek/pinfo

You are allowed to anonymously push to this repository.
This means that your pushed commits will automatically be transformed into a pull request:
... clone the repository ...
... make some changes and some commits ...
git push origin master