/* mini man implementation for busybox
* Copyright (C) 2008 Denys Vlasenko <vda.linux@googlemail.com>
- * Licensed under GPLv2, see file LICENSE in this tarball for details.
+ * Licensed under GPLv2, see file LICENSE in this source tree.
*/
+//usage:#define man_trivial_usage
+//usage: "[-aw] [MANPAGE]..."
+//usage:#define man_full_usage "\n\n"
+//usage: "Format and display manual page\n"
+//usage: "\n -a Display all pages"
+//usage: "\n -w Show page locations"
+
#include "libbb.h"
enum {
*/
-/* Trick gcc to reuse "cat" string. */
-#define STR_catNULmanNUL "cat\0man"
-#define STR_cat "cat\0man"
-
-//TODO: make gz/bz2 support conditional on FEATURE_SEAMLESS_GZ/BZ2,
-// add SEAMLESS_LZMA support
-
static int show_manpage(const char *pager, char *man_filename, int man, int level);
-static int run_pipe(const char *unpacker, const char *pager, char *man_filename, int man, int level)
+static int run_pipe(const char *pager, char *man_filename, int man, int level)
{
char *cmd;
}
if (man) { /* man page, not cat page */
- /* Test whether the man page is not a link to another one. */
+ /* Is this a link to another manpage? */
/* The link has the following on the first line: */
/* ".so another_man_page" */
+
struct stat sb;
char *line;
char *linkname, *p;
* ".so man7/path_resolution.7\n<junk>"
*/
*strchrnul(line, '\n') = '\0';
- linkname = p = skip_whitespace(&line[4]);
+ linkname = skip_whitespace(&line[4]);
/* If link has no slashes, we just replace man page name.
* If link has slashes (however many), we go back *once*.
/* Links do not have .gz extensions, even if manpage
* is compressed */
- man_filename = xasprintf("%s/%s" ".bz2", man_filename, linkname);
+ man_filename = xasprintf("%s/%s", man_filename, linkname);
free(line);
/* Note: we leak "new" man_filename string as well... */
if (show_manpage(pager, man_filename, man, level + 1))
}
ordinary_manpage:
+ close(STDIN_FILENO);
+ open_zipped(man_filename); /* guaranteed to use fd 0 (STDIN_FILENO) */
/* "2>&1" is added so that nroff errors are shown in pager too.
* Otherwise it may show just empty screen */
cmd = xasprintf(
- man ? "%s '%s' 2>&1 | gtbl | nroff -Tlatin1 -mandoc 2>&1 | %s"
- : "%s '%s' 2>&1 | %s",
- unpacker, man_filename, pager);
+ man ? "gtbl | nroff -Tlatin1 -mandoc 2>&1 | %s"
+ : "%s",
+ pager);
system(cmd);
free(cmd);
return 1;
}
-/* man_filename is of the form "/dir/dir/dir/name.s.bz2" */
+/* man_filename is of the form "/dir/dir/dir/name.s" */
static int show_manpage(const char *pager, char *man_filename, int man, int level)
{
- int len;
-
- if (run_pipe("bunzip2 -c", pager, man_filename, man, level))
+#if SEAMLESS_COMPRESSION
+ /* We leak this allocation... */
+ char *filename_with_zext = xasprintf("%s.lzma", man_filename);
+ char *ext = strrchr(filename_with_zext, '.') + 1;
+#endif
+
+#if ENABLE_FEATURE_SEAMLESS_LZMA
+ if (run_pipe(pager, filename_with_zext, man, level))
return 1;
-
- len = strlen(man_filename) - 1;
-
- man_filename[len] = '\0'; /* ".bz2" -> ".gz" */
- man_filename[len - 2] = 'g';
- if (run_pipe("gunzip -c", pager, man_filename, man, level))
+#endif
+#if ENABLE_FEATURE_SEAMLESS_XZ
+ strcpy(ext, "xz");
+ if (run_pipe(pager, filename_with_zext, man, level))
return 1;
-
- man_filename[len - 3] = '\0'; /* ".gz" -> "" */
- if (run_pipe(STR_cat, pager, man_filename, man, level))
+#endif
+#if ENABLE_FEATURE_SEAMLESS_BZ2
+ strcpy(ext, "bz2");
+ if (run_pipe(pager, filename_with_zext, man, level))
+ return 1;
+#endif
+#if ENABLE_FEATURE_SEAMLESS_GZ
+ strcpy(ext, "gz");
+ if (run_pipe(pager, filename_with_zext, man, level))
return 1;
+#endif
- return 0;
+ return run_pipe(pager, man_filename, man, level);
}
int man_main(int argc, char **argv) MAIN_EXTERNALLY_VISIBLE;
sec_list = xstrdup("1:2:3:4:5:6:7:8:9");
/* Last valid man_path_list[] is [0x10] */
- man_path_list = xzalloc(0x11 * sizeof(man_path_list[0]));
count_mp = 0;
- man_path_list[0] = xstrdup(getenv("MANPATH"));
- if (man_path_list[0])
+ man_path_list = xzalloc(0x11 * sizeof(man_path_list[0]));
+ man_path_list[0] = getenv("MANPATH");
+ if (!man_path_list[0]) /* default, may be overridden by /etc/man.conf */
+ man_path_list[0] = (char*)"/usr/man";
+ else
count_mp++;
pager = getenv("MANPAGER");
if (!pager) {
pager = "more";
}
- /* Parse man.conf */
- parser = config_open("/etc/man.conf");
+ /* Parse man.conf[ig] or man_db.conf */
+ /* man version 1.6f uses man.config */
+ /* man-db implementation of man uses man_db.conf */
+ parser = config_open2("/etc/man.config", fopen_for_read);
+ if (!parser)
+ parser = config_open2("/etc/man.conf", fopen_for_read);
+ if (!parser)
+ parser = config_open2("/etc/man_db.conf", fopen_for_read);
+
while (config_read(parser, token, 2, 0, "# \t", PARSE_NORMAL)) {
if (!token[1])
continue;
- if (strcmp("MANPATH", token[0]) == 0) {
- man_path_list = xrealloc_vector(man_path_list, 4, count_mp);
- man_path_list[count_mp] = xstrdup(token[1]);
- count_mp++;
- /* man_path_list is NULL terminated */
- /*man_path_list[count_mp] = NULL; - xrealloc_vector did it */
+ if (strcmp("MANDATORY_MANPATH"+10, token[0]) == 0 /* "MANPATH"? */
+ || strcmp("MANDATORY_MANPATH", token[0]) == 0
+ ) {
+ char *path = token[1];
+ while (*path) {
+ char *next_path;
+ char **path_element;
+
+ next_path = strchr(path, ':');
+ if (next_path) {
+ *next_path = '\0';
+ if (next_path++ == path) /* "::"? */
+ goto next;
+ }
+ /* Do we already have path? */
+ path_element = man_path_list;
+ while (*path_element) {
+ if (strcmp(*path_element, path) == 0)
+ goto skip;
+ path_element++;
+ }
+ man_path_list = xrealloc_vector(man_path_list, 4, count_mp);
+ man_path_list[count_mp] = xstrdup(path);
+ count_mp++;
+ /* man_path_list is NULL terminated */
+ /*man_path_list[count_mp] = NULL; - xrealloc_vector did it */
+ skip:
+ if (!next_path)
+ break;
+ next:
+ path = next_path;
+ }
}
if (strcmp("MANSECT", token[0]) == 0) {
free(sec_list);
do { /* for each argv[] */
int found = 0;
cur_mp = 0;
+
+ if (strchr(*argv, '/')) {
+ found = show_manpage(pager, *argv, /*man:*/ 1, 0);
+ goto check_found;
+ }
while ((cur_path = man_path_list[cur_mp++]) != NULL) {
/* for each MANPATH */
- do { /* for each MANPATH item */
- char *next_path = strchrnul(cur_path, ':');
- int path_len = next_path - cur_path;
- cur_sect = sec_list;
- do { /* for each section */
- char *next_sect = strchrnul(cur_sect, ':');
- int sect_len = next_sect - cur_sect;
- char *man_filename;
- int cat0man1 = 0;
-
- /* Search for cat, then man page */
- while (cat0man1 < 2) {
- int found_here;
- man_filename = xasprintf("%.*s/%s%.*s/%s.%.*s" ".bz2",
- path_len, cur_path,
- STR_catNULmanNUL + cat0man1 * 4,
- sect_len, cur_sect,
- *argv,
- sect_len, cur_sect);
- found_here = show_manpage(pager, man_filename, cat0man1, 0);
- found |= found_here;
- cat0man1 += found_here + 1;
- free(man_filename);
- }
-
- if (found && !(opt & OPT_a))
- goto next_arg;
- cur_sect = next_sect;
- while (*cur_sect == ':')
- cur_sect++;
- } while (*cur_sect);
- cur_path = next_path;
- while (*cur_path == ':')
- cur_path++;
- } while (*cur_path);
+ cur_sect = sec_list;
+ do { /* for each section */
+ char *next_sect = strchrnul(cur_sect, ':');
+ int sect_len = next_sect - cur_sect;
+ char *man_filename;
+ int cat0man1 = 0;
+
+ /* Search for cat, then man page */
+ while (cat0man1 < 2) {
+ int found_here;
+ man_filename = xasprintf("%s/%s%.*s/%s.%.*s",
+ cur_path,
+ "cat\0man" + (cat0man1 * 4),
+ sect_len, cur_sect,
+ *argv,
+ sect_len, cur_sect);
+ found_here = show_manpage(pager, man_filename, cat0man1, 0);
+ found |= found_here;
+ cat0man1 += found_here + 1;
+ free(man_filename);
+ }
+
+ if (found && !(opt & OPT_a))
+ goto next_arg;
+ cur_sect = next_sect;
+ while (*cur_sect == ':')
+ cur_sect++;
+ } while (*cur_sect);
}
+ check_found:
if (!found) {
bb_error_msg("no manual entry for '%s'", *argv);
not_found = 1;