1 /* mini man implementation for busybox
2 * Copyright (C) 2008 Denys Vlasenko <vda.linux@googlemail.com>
3 * Licensed under GPLv2, see file LICENSE in this tarball for details.
10 OPT_w = 2, /* print path */
13 /* This is what I see on my desktop system being executed:
19 gunzip -c '/usr/man/man1/bzip2.1.gz'
22 ) | gtbl | nroff -Tlatin1 -mandoc | less
26 /* Trick gcc to reuse "cat" string. */
27 #define STR_catNULmanNUL "cat\0man"
28 #define STR_cat "cat\0man"
30 static int run_pipe(const char *unpacker, const char *pager, char *man_filename, int man)
34 if (access(man_filename, R_OK) != 0)
37 if (option_mask32 & OPT_w) {
42 /* "2>&1" is added so that nroff errors are shown in pager too.
43 * Otherwise it may show just empty screen */
45 man ? "%s '%s' | gtbl | nroff -Tlatin1 -mandoc 2>&1 | %s"
47 unpacker, man_filename, pager);
53 /* man_filename is of the form "/dir/dir/dir/name.s.bz2" */
54 static int show_manpage(const char *pager, char *man_filename, int man)
58 if (run_pipe("bunzip2 -c", pager, man_filename, man))
61 len = strlen(man_filename) - 1;
63 man_filename[len] = '\0'; /* ".bz2" -> ".gz" */
64 man_filename[len - 2] = 'g';
65 if (run_pipe("gunzip -c", pager, man_filename, man))
68 man_filename[len - 3] = '\0'; /* ".gz" -> "" */
69 if (run_pipe(STR_cat, pager, man_filename, man))
75 int man_main(int argc, char **argv) MAIN_EXTERNALLY_VISIBLE;
76 int man_main(int argc ATTRIBUTE_UNUSED, char **argv)
82 char *cur_path, *cur_sect;
87 opt_complementary = "-1"; /* at least one argument */
88 opt = getopt32(argv, "+aw");
91 sec_list = xstrdup("1:2:3:4:5:6:7:8:9");
92 /* Last valid man_path_list[] is [0x10] */
93 man_path_list = xzalloc(0x11 * sizeof(man_path_list[0]));
95 man_path_list[0] = xstrdup(getenv("MANPATH"));
98 pager = getenv("MANPAGER");
100 pager = getenv("PAGER");
106 cf = fopen_or_warn("/etc/man.conf", "r");
108 /* go through man configuration file and search relevant paths, sections */
109 while ((line = xmalloc_fgetline(cf)) != NULL) {
110 trim(line); /* remove whitespace at the beginning/end */
111 if (isspace(line[7])) {
113 value = skip_whitespace(&line[8]);
114 *skip_non_whitespace(value) = '\0';
115 if (strcmp("MANPATH", line) == 0) {
116 man_path_list[count_mp] = xstrdup(value);
118 /* man_path_list is NULL terminated */
119 man_path_list[count_mp] = NULL;
120 if (!(count_mp & 0xf)) { /* 0x10, 0x20 etc */
121 /* so that last valid man_path_list[] is [count_mp + 0x10] */
122 man_path_list = xrealloc(man_path_list,
123 (count_mp + 0x11) * sizeof(man_path_list[0]));
126 if (strcmp("MANSECT", line) == 0) {
128 sec_list = xstrdup(value);
136 // TODO: my man3/getpwuid.3.gz contains just one line:
137 // .so man3/getpwnam.3
138 // (and I _dont_ have man3/getpwnam.3, I have man3/getpwnam.3.gz)
139 // need to support this...
142 do { /* for each argv[] */
145 while ((cur_path = man_path_list[cur_mp++]) != NULL) {
146 /* for each MANPATH */
147 do { /* for each MANPATH item */
148 char *next_path = strchrnul(cur_path, ':');
149 int path_len = next_path - cur_path;
151 do { /* for each section */
152 char *next_sect = strchrnul(cur_sect, ':');
153 int sect_len = next_sect - cur_sect;
157 /* Search for cat, then man page */
158 while (cat0man1 < 2) {
160 man_filename = xasprintf("%.*s/%s%.*s/%s.%.*s" ".bz2",
162 STR_catNULmanNUL + cat0man1 * 4,
166 found_here = show_manpage(pager, man_filename, cat0man1);
168 cat0man1 += found_here + 1;
172 if (found && !(opt & OPT_a))
174 cur_sect = next_sect;
175 while (*cur_sect == ':')
178 cur_path = next_path;
179 while (*cur_path == ':')
184 bb_error_msg("no manual entry for '%s'", *argv);