man: default to ascii
[oweals/busybox.git] / miscutils / man.c
index 24551c0e06d79ae640a333f5e96a7f2ae6b33f2f..5c1fa2c9dedea0b433668d64727614b21707a028 100644 (file)
@@ -1,8 +1,15 @@
 /* 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 {
@@ -23,16 +30,6 @@ echo ".pl \n(nlu+10"
 
 */
 
-#if ENABLE_FEATURE_SEAMLESS_LZMA
-#define Z_SUFFIX ".lzma"
-#elif ENABLE_FEATURE_SEAMLESS_BZ2
-#define Z_SUFFIX ".bz2"
-#elif ENABLE_FEATURE_SEAMLESS_GZ
-#define Z_SUFFIX ".gz"
-#else
-#define Z_SUFFIX ""
-#endif
-
 static int show_manpage(const char *pager, char *man_filename, int man, int level);
 
 static int run_pipe(const char *pager, char *man_filename, int man, int level)
@@ -95,7 +92,7 @@ static int run_pipe(const char *pager, char *man_filename, int man, int level)
 
                /* Links do not have .gz extensions, even if manpage
                 * is compressed */
-               man_filename = xasprintf("%s/%s" Z_SUFFIX, 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))
@@ -105,11 +102,12 @@ static int run_pipe(const char *pager, char *man_filename, int man, int level)
 
  ordinary_manpage:
        close(STDIN_FILENO);
-       open_zipped(man_filename); /* guaranteed to use fd 0 (STDIN_FILENO) */
+       open_zipped(man_filename, /*fail_if_not_compressed:*/ 0); /* 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 ? "gtbl | nroff -Tlatin1 -mandoc 2>&1 | %s"
+               /* replaced -Tlatin1 with -Tascii for non-UTF8 displays */
+               man ? "gtbl | nroff -Tascii -mandoc 2>&1 | %s"
                    : "%s",
                pager);
        system(cmd);
@@ -117,44 +115,43 @@ static int run_pipe(const char *pager, char *man_filename, int man, int level)
        return 1;
 }
 
-/* man_filename is of the form "/dir/dir/dir/name.s" Z_SUFFIX */
+/* 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)
 {
-#if ENABLE_FEATURE_SEAMLESS_LZMA
-       if (run_pipe(pager, man_filename, man, level))
-               return 1;
+#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_BZ2
 #if ENABLE_FEATURE_SEAMLESS_LZMA
-       strcpy(strrchr(man_filename, '.') + 1, "bz2");
-#endif
-       if (run_pipe(pager, man_filename, man, level))
+       if (run_pipe(pager, filename_with_zext, man, level))
                return 1;
 #endif
-
-#if ENABLE_FEATURE_SEAMLESS_GZ
-#if ENABLE_FEATURE_SEAMLESS_LZMA || ENABLE_FEATURE_SEAMLESS_BZ2
-       strcpy(strrchr(man_filename, '.') + 1, "gz");
-#endif
-       if (run_pipe(pager, man_filename, man, level))
+#if ENABLE_FEATURE_SEAMLESS_XZ
+       strcpy(ext, "xz");
+       if (run_pipe(pager, filename_with_zext, man, level))
                return 1;
 #endif
-
-#if ENABLE_FEATURE_SEAMLESS_LZMA || ENABLE_FEATURE_SEAMLESS_BZ2 || ENABLE_FEATURE_SEAMLESS_GZ
-       *strrchr(man_filename, '.') = '\0';
+#if ENABLE_FEATURE_SEAMLESS_BZ2
+       strcpy(ext, "bz2");
+       if (run_pipe(pager, filename_with_zext, man, level))
+               return 1;
 #endif
-       if (run_pipe(pager, man_filename, man, level))
+#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;
 int man_main(int argc UNUSED_PARAM, char **argv)
 {
        parser_t *parser;
-       const char *pager;
+       const char *pager = ENABLE_LESS ? "less" : "more";
        char **man_path_list;
        char *sec_list;
        char *cur_path, *cur_sect;
@@ -166,7 +163,7 @@ int man_main(int argc UNUSED_PARAM, char **argv)
        opt = getopt32(argv, "+aw");
        argv += optind;
 
-       sec_list = xstrdup("1:2:3:4:5:6:7:8:9");
+       sec_list = xstrdup("0p:1:1p:2:3:3p:4:5:6:7:8:9");
        /* Last valid man_path_list[] is [0x10] */
        count_mp = 0;
        man_path_list = xzalloc(0x11 * sizeof(man_path_list[0]));
@@ -175,40 +172,73 @@ int man_main(int argc UNUSED_PARAM, char **argv)
                man_path_list[0] = (char*)"/usr/man";
        else
                count_mp++;
-       pager = getenv("MANPAGER");
-       if (!pager) {
-               pager = getenv("PAGER");
-               if (!pager)
-                       pager = "more";
-       }
 
-       /* Parse man.conf */
-       parser = config_open2("/etc/man.conf", fopen_for_read);
+       /* 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) {
-                       /* Do we already have it? */
-                       char **path_element = man_path_list;
-                       while (*path_element) {
-                               if (strcmp(*path_element, token[1]) == 0)
-                                       goto skip;
-                               path_element++;
+               if (strcmp("DEFINE", token[0]) == 0) {
+                       if (strncmp("pager", token[1], 5) == 0) {
+                               pager = xstrdup(skip_whitespace(token[1]) + 5);
+                       }
+               } else
+               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;
                        }
-                       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("MANSECT", token[0]) == 0) {
                        free(sec_list);
                        sec_list = xstrdup(token[1]);
                }
- skip: ;
        }
        config_close(parser);
 
+       {
+               /* environment overrides setting from man.config */
+               char *env_pager = getenv("MANPAGER");
+               if (!env_pager)
+                       env_pager = getenv("PAGER");
+               if (env_pager)
+                       pager = env_pager;
+       }
+
        not_found = 0;
        do { /* for each argv[] */
                int found = 0;
@@ -220,41 +250,34 @@ int man_main(int argc UNUSED_PARAM, char **argv)
                }
                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" Z_SUFFIX,
-                                                               path_len, 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);
-                               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) {