]> git.cameronkatri.com Git - mandoc.git/blob - main.c
git.ckatri.com / mandoc.git / blob
? search:
summary | shortlog | log | commit | commitdiff | tree
history | raw | HEAD
Tedu support for the -xsh4.2 argument to the mdoc(7) .St macro
[mandoc.git] / main.c
1 /* $Id: main.c,v 1.360 2021/10/04 21:29:17 schwarze Exp $ */
2 /*
3 * Copyright (c) 2010-2012, 2014-2021 Ingo Schwarze <schwarze@openbsd.org>
4 * Copyright (c) 2008-2012 Kristaps Dzonsons <kristaps@bsd.lv>
5 * Copyright (c) 2010 Joerg Sonnenberger <joerg@netbsd.org>
6 *
7 * Permission to use, copy, modify, and distribute this software for any
8 * purpose with or without fee is hereby granted, provided that the above
9 * copyright notice and this permission notice appear in all copies.
10 *
11 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHORS DISCLAIM ALL WARRANTIES
12 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
13 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR
14 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
15 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
16 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
17 * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
18 *
19 * Main program for mandoc(1), man(1), apropos(1), whatis(1), and help(1).
20 */
21 #include "config.h"
22
23 #include <sys/types.h>
24 #include <sys/ioctl.h>
25 #include <sys/param.h> /* MACHINE */
26 #include <sys/stat.h>
27 #include <sys/wait.h>
28
29 #include <assert.h>
30 #include <ctype.h>
31 #if HAVE_ERR
32 #include <err.h>
33 #endif
34 #include <errno.h>
35 #include <fcntl.h>
36 #include <glob.h>
37 #include <limits.h>
38 #if HAVE_SANDBOX_INIT
39 #include <sandbox.h>
40 #endif
41 #include <signal.h>
42 #include <stdio.h>
43 #include <stdint.h>
44 #include <stdlib.h>
45 #include <string.h>
46 #include <termios.h>
47 #include <time.h>
48 #include <unistd.h>
49
50 #include "mandoc_aux.h"
51 #include "mandoc.h"
52 #include "mandoc_xr.h"
53 #include "roff.h"
54 #include "mdoc.h"
55 #include "man.h"
56 #include "mandoc_parse.h"
57 #include "tag.h"
58 #include "term_tag.h"
59 #include "main.h"
60 #include "manconf.h"
61 #include "mansearch.h"
62
63 enum outmode {
64 OUTMODE_DEF = 0,
65 OUTMODE_FLN,
66 OUTMODE_LST,
67 OUTMODE_ALL,
68 OUTMODE_ONE
69 };
70
71 enum outt {
72 OUTT_ASCII = 0, /* -Tascii */
73 OUTT_LOCALE, /* -Tlocale */
74 OUTT_UTF8, /* -Tutf8 */
75 OUTT_TREE, /* -Ttree */
76 OUTT_MAN, /* -Tman */
77 OUTT_HTML, /* -Thtml */
78 OUTT_MARKDOWN, /* -Tmarkdown */
79 OUTT_LINT, /* -Tlint */
80 OUTT_PS, /* -Tps */
81 OUTT_PDF /* -Tpdf */
82 };
83
84 struct outstate {
85 struct tag_files *tag_files; /* Tagging state variables. */
86 void *outdata; /* data for output */
87 int use_pager;
88 int wstop; /* stop after a file with a warning */
89 int had_output; /* Some output was generated. */
90 enum outt outtype; /* which output to use */
91 };
92
93
94 int mandocdb(int, char *[]);
95
96 static void check_xr(struct manpaths *);
97 static void fs_append(char **, size_t, int,
98 size_t, const char *, enum form,
99 struct manpage **, size_t *);
100 static int fs_lookup(const struct manpaths *, size_t,
101 const char *, const char *, const char *,
102 struct manpage **, size_t *);
103 static int fs_search(const struct mansearch *,
104 const struct manpaths *, const char *,
105 struct manpage **, size_t *);
106 static void glob_esc(char **, const char *, const char *);
107 static void outdata_alloc(struct outstate *, struct manoutput *);
108 static void parse(struct mparse *, int, const char *,
109 struct outstate *, struct manconf *);
110 static void passthrough(int, int);
111 static void process_onefile(struct mparse *, struct manpage *,
112 int, struct outstate *, struct manconf *);
113 static void run_pager(struct outstate *, char *);
114 static pid_t spawn_pager(struct outstate *, char *);
115 static void usage(enum argmode) __attribute__((__noreturn__));
116 static int woptions(char *, enum mandoc_os *, int *);
117
118 static const int sec_prios[] = {1, 4, 5, 8, 6, 3, 7, 2, 9};
119 static char help_arg[] = "help";
120 static char *help_argv[] = {help_arg, NULL};
121
122
123 int
124 main(int argc, char *argv[])
125 {
126 struct manconf conf; /* Manpaths and output options. */
127 struct outstate outst; /* Output state. */
128 struct winsize ws; /* Result of ioctl(TIOCGWINSZ). */
129 struct mansearch search; /* Search options. */
130 struct manpage *res; /* Complete list of search results. */
131 struct manpage *resn; /* Search results for one name. */
132 struct mparse *mp; /* Opaque parser object. */
133 const char *conf_file; /* -C: alternate config file. */
134 const char *os_s; /* -I: Operating system for display. */
135 const char *progname, *sec, *ep;
136 char *defpaths; /* -M: override manpaths. */
137 char *auxpaths; /* -m: additional manpaths. */
138 char *oarg; /* -O: output option string. */
139 char *tagarg; /* -O tag: default value. */
140 unsigned char *uc;
141 size_t ressz; /* Number of elements in res[]. */
142 size_t resnsz; /* Number of elements in resn[]. */
143 size_t i, ib, ssz;
144 int options; /* Parser options. */
145 int show_usage; /* Invalid argument: give up. */
146 int prio, best_prio;
147 int startdir;
148 int c;
149 enum mandoc_os os_e; /* Check base system conventions. */
150 enum outmode outmode; /* According to command line. */
151
152 #if HAVE_PROGNAME
153 progname = getprogname();
154 #else
155 if (argc < 1)
156 progname = mandoc_strdup("mandoc");
157 else if ((progname = strrchr(argv[0], '/')) == NULL)
158 progname = argv[0];
159 else
160 ++progname;
161 setprogname(progname);
162 #endif
163
164 mandoc_msg_setoutfile(stderr);
165 if (strncmp(progname, "mandocdb", 8) == 0 ||
166 strcmp(progname, BINM_MAKEWHATIS) == 0)
167 return mandocdb(argc, argv);
168
169 #if HAVE_PLEDGE
170 if (pledge("stdio rpath wpath cpath tmppath tty proc exec", NULL) == -1) {
171 mandoc_msg(MANDOCERR_PLEDGE, 0, 0, "%s", strerror(errno));
172 return mandoc_msg_getrc();
173 }
174 #endif
175 #if HAVE_SANDBOX_INIT
176 if (sandbox_init(kSBXProfileNoInternet, SANDBOX_NAMED, NULL) == -1)
177 errx((int)MANDOCLEVEL_SYSERR, "sandbox_init");
178 #endif
179
180 /* Search options. */
181
182 memset(&conf, 0, sizeof(conf));
183 conf_file = NULL;
184 defpaths = auxpaths = NULL;
185
186 memset(&search, 0, sizeof(struct mansearch));
187 search.outkey = "Nd";
188 oarg = NULL;
189
190 if (strcmp(progname, BINM_MAN) == 0)
191 search.argmode = ARG_NAME;
192 else if (strcmp(progname, BINM_APROPOS) == 0)
193 search.argmode = ARG_EXPR;
194 else if (strcmp(progname, BINM_WHATIS) == 0)
195 search.argmode = ARG_WORD;
196 else if (strncmp(progname, "help", 4) == 0)
197 search.argmode = ARG_NAME;
198 else
199 search.argmode = ARG_FILE;
200
201 /* Parser options. */
202
203 options = MPARSE_SO | MPARSE_UTF8 | MPARSE_LATIN1;
204 os_e = MANDOC_OS_OTHER;
205 os_s = NULL;
206
207 /* Formatter options. */
208
209 memset(&outst, 0, sizeof(outst));
210 outst.tag_files = NULL;
211 outst.outtype = OUTT_LOCALE;
212 outst.use_pager = 1;
213
214 show_usage = 0;
215 outmode = OUTMODE_DEF;
216
217 while ((c = getopt(argc, argv,
218 "aC:cfhI:iK:klM:m:O:S:s:T:VW:w")) != -1) {
219 if (c == 'i' && search.argmode == ARG_EXPR) {
220 optind--;
221 break;
222 }
223 switch (c) {
224 case 'a':
225 outmode = OUTMODE_ALL;
226 break;
227 case 'C':
228 conf_file = optarg;
229 break;
230 case 'c':
231 outst.use_pager = 0;
232 break;
233 case 'f':
234 search.argmode = ARG_WORD;
235 break;
236 case 'h':
237 conf.output.synopsisonly = 1;
238 outst.use_pager = 0;
239 outmode = OUTMODE_ALL;
240 break;
241 case 'I':
242 if (strncmp(optarg, "os=", 3) != 0) {
243 mandoc_msg(MANDOCERR_BADARG_BAD, 0, 0,
244 "-I %s", optarg);
245 return mandoc_msg_getrc();
246 }
247 if (os_s != NULL) {
248 mandoc_msg(MANDOCERR_BADARG_DUPE, 0, 0,
249 "-I %s", optarg);
250 return mandoc_msg_getrc();
251 }
252 os_s = optarg + 3;
253 break;
254 case 'K':
255 options &= ~(MPARSE_UTF8 | MPARSE_LATIN1);
256 if (strcmp(optarg, "utf-8") == 0)
257 options |= MPARSE_UTF8;
258 else if (strcmp(optarg, "iso-8859-1") == 0)
259 options |= MPARSE_LATIN1;
260 else if (strcmp(optarg, "us-ascii") != 0) {
261 mandoc_msg(MANDOCERR_BADARG_BAD, 0, 0,
262 "-K %s", optarg);
263 return mandoc_msg_getrc();
264 }
265 break;
266 case 'k':
267 search.argmode = ARG_EXPR;
268 break;
269 case 'l':
270 search.argmode = ARG_FILE;
271 outmode = OUTMODE_ALL;
272 break;
273 case 'M':
274 defpaths = optarg;
275 break;
276 case 'm':
277 auxpaths = optarg;
278 break;
279 case 'O':
280 oarg = optarg;
281 break;
282 case 'S':
283 search.arch = optarg;
284 break;
285 case 's':
286 search.sec = optarg;
287 break;
288 case 'T':
289 if (strcmp(optarg, "ascii") == 0)
290 outst.outtype = OUTT_ASCII;
291 else if (strcmp(optarg, "lint") == 0) {
292 outst.outtype = OUTT_LINT;
293 mandoc_msg_setoutfile(stdout);
294 mandoc_msg_setmin(MANDOCERR_BASE);
295 } else if (strcmp(optarg, "tree") == 0)
296 outst.outtype = OUTT_TREE;
297 else if (strcmp(optarg, "man") == 0)
298 outst.outtype = OUTT_MAN;
299 else if (strcmp(optarg, "html") == 0)
300 outst.outtype = OUTT_HTML;
301 else if (strcmp(optarg, "markdown") == 0)
302 outst.outtype = OUTT_MARKDOWN;
303 else if (strcmp(optarg, "utf8") == 0)
304 outst.outtype = OUTT_UTF8;
305 else if (strcmp(optarg, "locale") == 0)
306 outst.outtype = OUTT_LOCALE;
307 else if (strcmp(optarg, "ps") == 0)
308 outst.outtype = OUTT_PS;
309 else if (strcmp(optarg, "pdf") == 0)
310 outst.outtype = OUTT_PDF;
311 else {
312 mandoc_msg(MANDOCERR_BADARG_BAD, 0, 0,
313 "-T %s", optarg);
314 return mandoc_msg_getrc();
315 }
316 break;
317 case 'W':
318 if (woptions(optarg, &os_e, &outst.wstop) == -1)
319 return mandoc_msg_getrc();
320 break;
321 case 'w':
322 outmode = OUTMODE_FLN;
323 break;
324 default:
325 show_usage = 1;
326 break;
327 }
328 }
329
330 if (show_usage)
331 usage(search.argmode);
332
333 /* Postprocess options. */
334
335 switch (outmode) {
336 case OUTMODE_DEF:
337 switch (search.argmode) {
338 case ARG_FILE:
339 outmode = OUTMODE_ALL;
340 outst.use_pager = 0;
341 break;
342 case ARG_NAME:
343 outmode = OUTMODE_ONE;
344 break;
345 default:
346 outmode = OUTMODE_LST;
347 break;
348 }
349 break;
350 case OUTMODE_FLN:
351 if (search.argmode == ARG_FILE)
352 outmode = OUTMODE_ALL;
353 break;
354 case OUTMODE_ALL:
355 break;
356 case OUTMODE_LST:
357 case OUTMODE_ONE:
358 abort();
359 }
360
361 if (oarg != NULL) {
362 if (outmode == OUTMODE_LST)
363 search.outkey = oarg;
364 else {
365 while (oarg != NULL) {
366 if (manconf_output(&conf.output,
367 strsep(&oarg, ","), 0) == -1)
368 return mandoc_msg_getrc();
369 }
370 }
371 }
372
373 if (outst.outtype != OUTT_TREE || conf.output.noval == 0)
374 options |= MPARSE_VALIDATE;
375
376 if (outmode == OUTMODE_FLN ||
377 outmode == OUTMODE_LST ||
378 (conf.output.outfilename == NULL &&
379 conf.output.tagfilename == NULL &&
380 isatty(STDOUT_FILENO) == 0))
381 outst.use_pager = 0;
382
383 if (outst.use_pager &&
384 (conf.output.width == 0 || conf.output.indent == 0) &&
385 ioctl(STDOUT_FILENO, TIOCGWINSZ, &ws) != -1 &&
386 ws.ws_col > 1) {
387 if (conf.output.width == 0 && ws.ws_col < 79)
388 conf.output.width = ws.ws_col - 1;
389 if (conf.output.indent == 0 && ws.ws_col < 66)
390 conf.output.indent = 3;
391 }
392
393 #if HAVE_PLEDGE
394 if (outst.use_pager == 0)
395 c = pledge("stdio rpath", NULL);
396 else if (conf.output.outfilename != NULL ||
397 conf.output.tagfilename != NULL)
398 c = pledge("stdio rpath wpath cpath", NULL);
399 else
400 c = pledge("stdio rpath tmppath tty proc exec", NULL);
401 if (c == -1) {
402 mandoc_msg(MANDOCERR_PLEDGE, 0, 0, "%s", strerror(errno));
403 return mandoc_msg_getrc();
404 }
405 #endif
406
407 /* Parse arguments. */
408
409 if (argc > 0) {
410 argc -= optind;
411 argv += optind;
412 }
413
414 /*
415 * Quirks for help(1) and man(1),
416 * in particular for a section argument without -s.
417 */
418
419 if (search.argmode == ARG_NAME) {
420 if (*progname == 'h') {
421 if (argc == 0) {
422 argv = help_argv;
423 argc = 1;
424 }
425 } else if (argc > 1 &&
426 ((uc = (unsigned char *)argv[0]) != NULL) &&
427 ((isdigit(uc[0]) && (uc[1] == '\0' ||
428 isalpha(uc[1]))) ||
429 (uc[0] == 'n' && uc[1] == '\0'))) {
430 search.sec = (char *)uc;
431 argv++;
432 argc--;
433 }
434 if (search.arch == NULL)
435 search.arch = getenv("MACHINE");
436 #ifdef MACHINE
437 if (search.arch == NULL)
438 search.arch = MACHINE;
439 #endif
440 if (outmode == OUTMODE_ONE)
441 search.firstmatch = 1;
442 }
443
444 /*
445 * Use the first argument for -O tag in addition to
446 * using it as a search term for man(1) or apropos(1).
447 */
448
449 if (conf.output.tag != NULL && *conf.output.tag == '\0') {
450 tagarg = argc > 0 && search.argmode == ARG_EXPR ?
451 strchr(*argv, '=') : NULL;
452 conf.output.tag = tagarg == NULL ? *argv : tagarg + 1;
453 }
454
455 /* Read the configuration file. */
456
457 if (search.argmode != ARG_FILE ||
458 mandoc_msg_getmin() == MANDOCERR_STYLE)
459 manconf_parse(&conf, conf_file, defpaths, auxpaths);
460
461 /* man(1): Resolve each name individually. */
462
463 if (search.argmode == ARG_NAME) {
464 if (argc < 1) {
465 if (outmode != OUTMODE_FLN)
466 usage(ARG_NAME);
467 if (conf.manpath.sz == 0) {
468 warnx("The manpath is empty.");
469 mandoc_msg_setrc(MANDOCLEVEL_BADARG);
470 } else {
471 for (i = 0; i + 1 < conf.manpath.sz; i++)
472 printf("%s:", conf.manpath.paths[i]);
473 printf("%s\n", conf.manpath.paths[i]);
474 }
475 manconf_free(&conf);
476 return (int)mandoc_msg_getrc();
477 }
478 for (res = NULL, ressz = 0; argc > 0; argc--, argv++) {
479 (void)mansearch(&search, &conf.manpath,
480 1, argv, &resn, &resnsz);
481 if (resnsz == 0)
482 (void)fs_search(&search, &conf.manpath,
483 *argv, &resn, &resnsz);
484 if (resnsz == 0 && strchr(*argv, '/') == NULL) {
485 if (search.arch != NULL &&
486 arch_valid(search.arch, OSENUM) == 0)
487 warnx("Unknown architecture \"%s\".",
488 search.arch);
489 else if (search.sec != NULL)
490 warnx("No entry for %s in "
491 "section %s of the manual.",
492 *argv, search.sec);
493 else
494 warnx("No entry for %s in "
495 "the manual.", *argv);
496 mandoc_msg_setrc(MANDOCLEVEL_BADARG);
497 continue;
498 }
499 if (resnsz == 0) {
500 if (access(*argv, R_OK) == -1) {
501 mandoc_msg_setinfilename(*argv);
502 mandoc_msg(MANDOCERR_BADARG_BAD,
503 0, 0, "%s", strerror(errno));
504 mandoc_msg_setinfilename(NULL);
505 continue;
506 }
507 resnsz = 1;
508 resn = mandoc_calloc(resnsz, sizeof(*res));
509 resn->file = mandoc_strdup(*argv);
510 resn->ipath = SIZE_MAX;
511 resn->form = FORM_SRC;
512 }
513 if (outmode != OUTMODE_ONE || resnsz == 1) {
514 res = mandoc_reallocarray(res,
515 ressz + resnsz, sizeof(*res));
516 memcpy(res + ressz, resn,
517 sizeof(*resn) * resnsz);
518 ressz += resnsz;
519 free(resn);
520 resn = NULL;
521 resnsz = 0;
522 continue;
523 }
524
525 /* Search for the best section. */
526
527 best_prio = 40;
528 for (ib = i = 0; i < resnsz; i++) {
529 sec = resn[i].file;
530 sec += strcspn(sec, "123456789");
531 if (sec[0] == '\0')
532 continue; /* No section at all. */
533 prio = sec_prios[sec[0] - '1'];
534 if (search.sec != NULL) {
535 ssz = strlen(search.sec);
536 if (strncmp(sec, search.sec, ssz) == 0)
537 sec += ssz;
538 } else
539 sec++; /* Prefer without suffix. */
540 if (*sec != '/')
541 prio += 10; /* Wrong dir name. */
542 if (search.sec != NULL) {
543 ep = strchr(sec, '\0');
544 if (ep - sec > 3 &&
545 strncmp(ep - 3, ".gz", 3) == 0)
546 ep -= 3;
547 if ((size_t)(ep - sec) < ssz + 3 ||
548 strncmp(ep - ssz, search.sec,
549 ssz) != 0) /* Wrong file */
550 prio += 20; /* extension. */
551 }
552 if (prio >= best_prio)
553 continue;
554 best_prio = prio;
555 ib = i;
556 }
557 res = mandoc_reallocarray(res, ressz + 1,
558 sizeof(*res));
559 memcpy(res + ressz++, resn + ib, sizeof(*resn));
560 memset(resn + ib, 0, sizeof(*resn));
561 mansearch_free(resn, resnsz);
562 resn = NULL;
563 resnsz = 0;
564 }
565
566 /* apropos(1), whatis(1): Process the full search expression. */
567
568 } else if (search.argmode != ARG_FILE) {
569 if (mansearch(&search, &conf.manpath,
570 argc, argv, &res, &ressz) == 0)
571 usage(search.argmode);
572
573 if (ressz == 0) {
574 warnx("nothing appropriate");
575 mandoc_msg_setrc(MANDOCLEVEL_BADARG);
576 goto out;
577 }
578
579 /* mandoc(1): Take command line arguments as file names. */
580
581 } else {
582 ressz = argc > 0 ? argc : 1;
583 res = mandoc_calloc(ressz, sizeof(*res));
584 for (i = 0; i < ressz; i++) {
585 if (argc > 0)
586 res[i].file = mandoc_strdup(argv[i]);
587 res[i].ipath = SIZE_MAX;
588 res[i].form = FORM_SRC;
589 }
590 }
591
592 switch (outmode) {
593 case OUTMODE_FLN:
594 for (i = 0; i < ressz; i++)
595 puts(res[i].file);
596 goto out;
597 case OUTMODE_LST:
598 for (i = 0; i < ressz; i++)
599 printf("%s - %s\n", res[i].names,
600 res[i].output == NULL ? "" :
601 res[i].output);
602 goto out;
603 default:
604 break;
605 }
606
607 if (search.argmode == ARG_FILE && auxpaths != NULL) {
608 if (strcmp(auxpaths, "doc") == 0)
609 options |= MPARSE_MDOC;
610 else if (strcmp(auxpaths, "an") == 0)
611 options |= MPARSE_MAN;
612 }
613
614 mchars_alloc();
615 mp = mparse_alloc(options, os_e, os_s);
616
617 /*
618 * Remember the original working directory, if possible.
619 * This will be needed if some names on the command line
620 * are page names and some are relative file names.
621 * Do not error out if the current directory is not
622 * readable: Maybe it won't be needed after all.
623 */
624 startdir = open(".", O_RDONLY | O_DIRECTORY);
625 for (i = 0; i < ressz; i++) {
626 process_onefile(mp, res + i, startdir, &outst, &conf);
627 if (outst.wstop && mandoc_msg_getrc() != MANDOCLEVEL_OK)
628 break;
629 }
630 if (startdir != -1) {
631 (void)fchdir(startdir);
632 close(startdir);
633 }
634 if (conf.output.tag != NULL && conf.output.tag_found == 0) {
635 mandoc_msg(MANDOCERR_TAG, 0, 0, "%s", conf.output.tag);
636 conf.output.tag = NULL;
637 }
638 if (outst.outdata != NULL) {
639 switch (outst.outtype) {
640 case OUTT_HTML:
641 html_free(outst.outdata);
642 break;
643 case OUTT_UTF8:
644 case OUTT_LOCALE:
645 case OUTT_ASCII:
646 ascii_free(outst.outdata);
647 break;
648 case OUTT_PDF:
649 case OUTT_PS:
650 pspdf_free(outst.outdata);
651 break;
652 default:
653 break;
654 }
655 }
656 mandoc_xr_free();
657 mparse_free(mp);
658 mchars_free();
659
660 out:
661 mansearch_free(res, ressz);
662 if (search.argmode != ARG_FILE)
663 manconf_free(&conf);
664
665 if (outst.tag_files != NULL) {
666 if (term_tag_close() != -1 &&
667 conf.output.outfilename == NULL &&
668 conf.output.tagfilename == NULL)
669 run_pager(&outst, conf.output.tag);
670 term_tag_unlink();
671 } else if (outst.had_output && outst.outtype != OUTT_LINT)
672 mandoc_msg_summary();
673
674 return (int)mandoc_msg_getrc();
675 }
676
677 static void
678 usage(enum argmode argmode)
679 {
680 switch (argmode) {
681 case ARG_FILE:
682 fputs("usage: mandoc [-ac] [-I os=name] "
683 "[-K encoding] [-mdoc | -man] [-O options]\n"
684 "\t [-T output] [-W level] [file ...]\n", stderr);
685 break;
686 case ARG_NAME:
687 fputs("usage: man [-acfhklw] [-C file] [-M path] "
688 "[-m path] [-S subsection]\n"
689 "\t [[-s] section] name ...\n", stderr);
690 break;
691 case ARG_WORD:
692 fputs("usage: whatis [-afk] [-C file] "
693 "[-M path] [-m path] [-O outkey] [-S arch]\n"
694 "\t [-s section] name ...\n", stderr);
695 break;
696 case ARG_EXPR:
697 fputs("usage: apropos [-afk] [-C file] "
698 "[-M path] [-m path] [-O outkey] [-S arch]\n"
699 "\t [-s section] expression ...\n", stderr);
700 break;
701 }
702 exit((int)MANDOCLEVEL_BADARG);
703 }
704
705 static void
706 glob_esc(char **dst, const char *src, const char *suffix)
707 {
708 while (*src != '\0') {
709 if (strchr("*?[", *src) != NULL)
710 *(*dst)++ = '\\';
711 *(*dst)++ = *src++;
712 }
713 while (*suffix != '\0')
714 *(*dst)++ = *suffix++;
715 }
716
717 static void
718 fs_append(char **file, size_t filesz, int copy, size_t ipath,
719 const char *sec, enum form form, struct manpage **res, size_t *ressz)
720 {
721 struct manpage *page;
722
723 *res = mandoc_reallocarray(*res, *ressz + filesz, sizeof(**res));
724 page = *res + *ressz;
725 *ressz += filesz;
726 for (;;) {
727 page->file = copy ? mandoc_strdup(*file) : *file;
728 page->names = NULL;
729 page->output = NULL;
730 page->bits = NAME_FILE & NAME_MASK;
731 page->ipath = ipath;
732 page->sec = (*sec >= '1' && *sec <= '9') ? *sec - '1' + 1 : 10;
733 page->form = form;
734 if (--filesz == 0)
735 break;
736 file++;
737 page++;
738 }
739 }
740
741 static int
742 fs_lookup(const struct manpaths *paths, size_t ipath,
743 const char *sec, const char *arch, const char *name,
744 struct manpage **res, size_t *ressz)
745 {
746 struct stat sb;
747 glob_t globinfo;
748 char *file, *cp, secnum[2];
749 int globres;
750 enum form form;
751
752 const char *const slman = "/man";
753 const char *const slash = "/";
754 const char *const sglob = ".[01-9]*";
755 const char *const dot = ".";
756 const char *const aster = "*";
757
758 memset(&globinfo, 0, sizeof(globinfo));
759 form = FORM_SRC;
760
761 mandoc_asprintf(&file, "%s/man%s/%s.%s",
762 paths->paths[ipath], sec, name, sec);
763 if (stat(file, &sb) != -1)
764 goto found;
765 free(file);
766
767 mandoc_asprintf(&file, "%s/cat%s/%s.0",
768 paths->paths[ipath], sec, name);
769 if (stat(file, &sb) != -1) {
770 form = FORM_CAT;
771 goto found;
772 }
773 free(file);
774
775 if (arch != NULL) {
776 mandoc_asprintf(&file, "%s/man%s/%s/%s.%s",
777 paths->paths[ipath], sec, arch, name, sec);
778 if (stat(file, &sb) != -1)
779 goto found;
780 free(file);
781 }
782
783 cp = file = mandoc_malloc(strlen(paths->paths[ipath]) * 2 +
784 strlen(slman) + strlen(sec) * 2 + strlen(slash) +
785 strlen(name) * 2 + strlen(sglob) + 1);
786 glob_esc(&cp, paths->paths[ipath], slman);
787 glob_esc(&cp, sec, slash);
788 glob_esc(&cp, name, sglob);
789 *cp = '\0';
790 globres = glob(file, 0, NULL, &globinfo);
791 if (globres != 0 && globres != GLOB_NOMATCH)
792 mandoc_msg(MANDOCERR_GLOB, 0, 0,
793 "%s: %s", file, strerror(errno));
794 free(file);
795 file = NULL;
796 if (globres == 0)
797 goto found;
798 globfree(&globinfo);
799
800 if (sec[1] != '\0' && *ressz == 0) {
801 secnum[0] = sec[0];
802 secnum[1] = '\0';
803 cp = file = mandoc_malloc(strlen(paths->paths[ipath]) * 2 +
804 strlen(slman) + strlen(secnum) * 2 + strlen(slash) +
805 strlen(name) * 2 + strlen(dot) +
806 strlen(sec) * 2 + strlen(aster) + 1);
807 glob_esc(&cp, paths->paths[ipath], slman);
808 glob_esc(&cp, secnum, slash);
809 glob_esc(&cp, name, dot);
810 glob_esc(&cp, sec, aster);
811 *cp = '\0';
812 globres = glob(file, 0, NULL, &globinfo);
813 if (globres != 0 && globres != GLOB_NOMATCH)
814 mandoc_msg(MANDOCERR_GLOB, 0, 0,
815 "%s: %s", file, strerror(errno));
816 free(file);
817 file = NULL;
818 if (globres == 0)
819 goto found;
820 globfree(&globinfo);
821 }
822
823 if (res != NULL || ipath + 1 != paths->sz)
824 return -1;
825
826 mandoc_asprintf(&file, "%s.%s", name, sec);
827 globres = stat(file, &sb);
828 free(file);
829 return globres;
830
831 found:
832 warnx("outdated mandoc.db lacks %s(%s) entry, run %s %s",
833 name, sec, BINM_MAKEWHATIS, paths->paths[ipath]);
834 if (res == NULL)
835 free(file);
836 else if (file == NULL)
837 fs_append(globinfo.gl_pathv, globinfo.gl_pathc, 1,
838 ipath, sec, form, res, ressz);
839 else
840 fs_append(&file, 1, 0, ipath, sec, form, res, ressz);
841 globfree(&globinfo);
842 return 0;
843 }
844
845 static int
846 fs_search(const struct mansearch *cfg, const struct manpaths *paths,
847 const char *name, struct manpage **res, size_t *ressz)
848 {
849 const char *const sections[] =
850 {"1", "8", "6", "2", "3", "5", "7", "4", "9", "3p"};
851 const size_t nsec = sizeof(sections)/sizeof(sections[0]);
852
853 size_t ipath, isec;
854
855 assert(cfg->argmode == ARG_NAME);
856 if (res != NULL)
857 *res = NULL;
858 *ressz = 0;
859 for (ipath = 0; ipath < paths->sz; ipath++) {
860 if (cfg->sec != NULL) {
861 if (fs_lookup(paths, ipath, cfg->sec, cfg->arch,
862 name, res, ressz) != -1 && cfg->firstmatch)
863 return 0;
864 } else {
865 for (isec = 0; isec < nsec; isec++)
866 if (fs_lookup(paths, ipath, sections[isec],
867 cfg->arch, name, res, ressz) != -1 &&
868 cfg->firstmatch)
869 return 0;
870 }
871 }
872 return -1;
873 }
874
875 static void
876 process_onefile(struct mparse *mp, struct manpage *resp, int startdir,
877 struct outstate *outst, struct manconf *conf)
878 {
879 int fd;
880
881 /*
882 * Changing directories is not needed in ARG_FILE mode.
883 * Do it on a best-effort basis. Even in case of
884 * failure, some functionality may still work.
885 */
886 if (resp->ipath != SIZE_MAX)
887 (void)chdir(conf->manpath.paths[resp->ipath]);
888 else if (startdir != -1)
889 (void)fchdir(startdir);
890
891 mandoc_msg_setinfilename(resp->file);
892 if (resp->file != NULL) {
893 if ((fd = mparse_open(mp, resp->file)) == -1) {
894 mandoc_msg(resp->ipath == SIZE_MAX ?
895 MANDOCERR_BADARG_BAD : MANDOCERR_OPEN,
896 0, 0, "%s", strerror(errno));
897 mandoc_msg_setinfilename(NULL);
898 return;
899 }
900 } else
901 fd = STDIN_FILENO;
902
903 if (outst->use_pager) {
904 outst->use_pager = 0;
905 outst->tag_files = term_tag_init(conf->output.outfilename,
906 outst->outtype == OUTT_HTML ? ".html" : "",
907 conf->output.tagfilename);
908 #if HAVE_PLEDGE
909 if ((conf->output.outfilename != NULL ||
910 conf->output.tagfilename != NULL) &&
911 pledge("stdio rpath cpath", NULL) == -1) {
912 mandoc_msg(MANDOCERR_PLEDGE, 0, 0,
913 "%s", strerror(errno));
914 exit(mandoc_msg_getrc());
915 }
916 #endif
917 }
918 if (outst->had_output && outst->outtype <= OUTT_UTF8) {
919 if (outst->outdata == NULL)
920 outdata_alloc(outst, &conf->output);
921 terminal_sepline(outst->outdata);
922 }
923
924 if (resp->form == FORM_SRC)
925 parse(mp, fd, resp->file, outst, conf);
926 else {
927 passthrough(fd, conf->output.synopsisonly);
928 outst->had_output = 1;
929 }
930
931 if (ferror(stdout)) {
932 if (outst->tag_files != NULL) {
933 mandoc_msg(MANDOCERR_WRITE, 0, 0, "%s: %s",
934 outst->tag_files->ofn, strerror(errno));
935 term_tag_unlink();
936 outst->tag_files = NULL;
937 } else
938 mandoc_msg(MANDOCERR_WRITE, 0, 0, "%s",
939 strerror(errno));
940 }
941 mandoc_msg_setinfilename(NULL);
942 }
943
944 static void
945 parse(struct mparse *mp, int fd, const char *file,
946 struct outstate *outst, struct manconf *conf)
947 {
948 static struct manpaths basepaths;
949 static int previous;
950 struct roff_meta *meta;
951
952 assert(fd >= 0);
953 if (file == NULL)
954 file = "<stdin>";
955
956 if (previous)
957 mparse_reset(mp);
958 else
959 previous = 1;
960
961 mparse_readfd(mp, fd, file);
962 if (fd != STDIN_FILENO)
963 close(fd);
964
965 /*
966 * With -Wstop and warnings or errors of at least the requested
967 * level, do not produce output.
968 */
969
970 if (outst->wstop && mandoc_msg_getrc() != MANDOCLEVEL_OK)
971 return;
972
973 if (outst->outdata == NULL)
974 outdata_alloc(outst, &conf->output);
975 else if (outst->outtype == OUTT_HTML)
976 html_reset(outst->outdata);
977
978 mandoc_xr_reset();
979 meta = mparse_result(mp);
980
981 /* Execute the out device, if it exists. */
982
983 outst->had_output = 1;
984 if (meta->macroset == MACROSET_MDOC) {
985 switch (outst->outtype) {
986 case OUTT_HTML:
987 html_mdoc(outst->outdata, meta);
988 break;
989 case OUTT_TREE:
990 tree_mdoc(outst->outdata, meta);
991 break;
992 case OUTT_MAN:
993 man_mdoc(outst->outdata, meta);
994 break;
995 case OUTT_PDF:
996 case OUTT_ASCII:
997 case OUTT_UTF8:
998 case OUTT_LOCALE:
999 case OUTT_PS:
1000 terminal_mdoc(outst->outdata, meta);
1001 break;
1002 case OUTT_MARKDOWN:
1003 markdown_mdoc(outst->outdata, meta);
1004 break;
1005 default:
1006 break;
1007 }
1008 }
1009 if (meta->macroset == MACROSET_MAN) {
1010 switch (outst->outtype) {
1011 case OUTT_HTML:
1012 html_man(outst->outdata, meta);
1013 break;
1014 case OUTT_TREE:
1015 tree_man(outst->outdata, meta);
1016 break;
1017 case OUTT_MAN:
1018 mparse_copy(mp);
1019 break;
1020 case OUTT_PDF:
1021 case OUTT_ASCII:
1022 case OUTT_UTF8:
1023 case OUTT_LOCALE:
1024 case OUTT_PS:
1025 terminal_man(outst->outdata, meta);
1026 break;
1027 case OUTT_MARKDOWN:
1028 mandoc_msg(MANDOCERR_MAN_TMARKDOWN, 0, 0, NULL);
1029 break;
1030 default:
1031 break;
1032 }
1033 }
1034 if (conf->output.tag != NULL && conf->output.tag_found == 0 &&
1035 tag_exists(conf->output.tag))
1036 conf->output.tag_found = 1;
1037
1038 if (mandoc_msg_getmin() < MANDOCERR_STYLE) {
1039 if (basepaths.sz == 0)
1040 manpath_base(&basepaths);
1041 check_xr(&basepaths);
1042 } else if (mandoc_msg_getmin() < MANDOCERR_WARNING)
1043 check_xr(&conf->manpath);
1044 }
1045
1046 static void
1047 check_xr(struct manpaths *paths)
1048 {
1049 struct mansearch search;
1050 struct mandoc_xr *xr;
1051 size_t sz;
1052
1053 for (xr = mandoc_xr_get(); xr != NULL; xr = xr->next) {
1054 if (xr->line == -1)
1055 continue;
1056 search.arch = NULL;
1057 search.sec = xr->sec;
1058 search.outkey = NULL;
1059 search.argmode = ARG_NAME;
1060 search.firstmatch = 1;
1061 if (mansearch(&search, paths, 1, &xr->name, NULL, &sz))
1062 continue;
1063 if (fs_search(&search, paths, xr->name, NULL, &sz) != -1)
1064 continue;
1065 if (xr->count == 1)
1066 mandoc_msg(MANDOCERR_XR_BAD, xr->line,
1067 xr->pos + 1, "Xr %s %s", xr->name, xr->sec);
1068 else
1069 mandoc_msg(MANDOCERR_XR_BAD, xr->line,
1070 xr->pos + 1, "Xr %s %s (%d times)",
1071 xr->name, xr->sec, xr->count);
1072 }
1073 }
1074
1075 static void
1076 outdata_alloc(struct outstate *outst, struct manoutput *outconf)
1077 {
1078 switch (outst->outtype) {
1079 case OUTT_HTML:
1080 outst->outdata = html_alloc(outconf);
1081 break;
1082 case OUTT_UTF8:
1083 outst->outdata = utf8_alloc(outconf);
1084 break;
1085 case OUTT_LOCALE:
1086 outst->outdata = locale_alloc(outconf);
1087 break;
1088 case OUTT_ASCII:
1089 outst->outdata = ascii_alloc(outconf);
1090 break;
1091 case OUTT_PDF:
1092 outst->outdata = pdf_alloc(outconf);
1093 break;
1094 case OUTT_PS:
1095 outst->outdata = ps_alloc(outconf);
1096 break;
1097 default:
1098 break;
1099 }
1100 }
1101
1102 static void
1103 passthrough(int fd, int synopsis_only)
1104 {
1105 const char synb[] = "S\bSY\bYN\bNO\bOP\bPS\bSI\bIS\bS";
1106 const char synr[] = "SYNOPSIS";
1107
1108 FILE *stream;
1109 char *line, *cp;
1110 size_t linesz;
1111 ssize_t len, written;
1112 int lno, print;
1113
1114 stream = NULL;
1115 line = NULL;
1116 linesz = 0;
1117
1118 if (fflush(stdout) == EOF) {
1119 mandoc_msg(MANDOCERR_FFLUSH, 0, 0, "%s", strerror(errno));
1120 goto done;
1121 }
1122 if ((stream = fdopen(fd, "r")) == NULL) {
1123 close(fd);
1124 mandoc_msg(MANDOCERR_FDOPEN, 0, 0, "%s", strerror(errno));
1125 goto done;
1126 }
1127
1128 lno = print = 0;
1129 while ((len = getline(&line, &linesz, stream)) != -1) {
1130 lno++;
1131 cp = line;
1132 if (synopsis_only) {
1133 if (print) {
1134 if ( ! isspace((unsigned char)*cp))
1135 goto done;
1136 while (isspace((unsigned char)*cp)) {
1137 cp++;
1138 len--;
1139 }
1140 } else {
1141 if (strcmp(cp, synb) == 0 ||
1142 strcmp(cp, synr) == 0)
1143 print = 1;
1144 continue;
1145 }
1146 }
1147 for (; len > 0; len -= written) {
1148 if ((written = write(STDOUT_FILENO, cp, len)) == -1) {
1149 mandoc_msg(MANDOCERR_WRITE, 0, 0,
1150 "%s", strerror(errno));
1151 goto done;
1152 }
1153 }
1154 }
1155 if (ferror(stream))
1156 mandoc_msg(MANDOCERR_GETLINE, lno, 0, "%s", strerror(errno));
1157
1158 done:
1159 free(line);
1160 if (stream != NULL)
1161 fclose(stream);
1162 }
1163
1164 static int
1165 woptions(char *arg, enum mandoc_os *os_e, int *wstop)
1166 {
1167 char *v, *o;
1168 const char *toks[11];
1169
1170 toks[0] = "stop";
1171 toks[1] = "all";
1172 toks[2] = "base";
1173 toks[3] = "style";
1174 toks[4] = "warning";
1175 toks[5] = "error";
1176 toks[6] = "unsupp";
1177 toks[7] = "fatal";
1178 toks[8] = "openbsd";
1179 toks[9] = "netbsd";
1180 toks[10] = NULL;
1181
1182 while (*arg) {
1183 o = arg;
1184 switch (getsubopt(&arg, (char * const *)toks, &v)) {
1185 case 0:
1186 *wstop = 1;
1187 break;
1188 case 1:
1189 case 2:
1190 mandoc_msg_setmin(MANDOCERR_BASE);
1191 break;
1192 case 3:
1193 mandoc_msg_setmin(MANDOCERR_STYLE);
1194 break;
1195 case 4:
1196 mandoc_msg_setmin(MANDOCERR_WARNING);
1197 break;
1198 case 5:
1199 mandoc_msg_setmin(MANDOCERR_ERROR);
1200 break;
1201 case 6:
1202 mandoc_msg_setmin(MANDOCERR_UNSUPP);
1203 break;
1204 case 7:
1205 mandoc_msg_setmin(MANDOCERR_BADARG);
1206 break;
1207 case 8:
1208 mandoc_msg_setmin(MANDOCERR_BASE);
1209 *os_e = MANDOC_OS_OPENBSD;
1210 break;
1211 case 9:
1212 mandoc_msg_setmin(MANDOCERR_BASE);
1213 *os_e = MANDOC_OS_NETBSD;
1214 break;
1215 default:
1216 mandoc_msg(MANDOCERR_BADARG_BAD, 0, 0, "-W %s", o);
1217 return -1;
1218 }
1219 }
1220 return 0;
1221 }
1222
1223 /*
1224 * Wait until moved to the foreground,
1225 * then fork the pager and wait for the user to close it.
1226 */
1227 static void
1228 run_pager(struct outstate *outst, char *tag_target)
1229 {
1230 int signum, status;
1231 pid_t man_pgid, tc_pgid;
1232 pid_t pager_pid, wait_pid;
1233
1234 man_pgid = getpgid(0);
1235 outst->tag_files->tcpgid =
1236 man_pgid == getpid() ? getpgid(getppid()) : man_pgid;
1237 pager_pid = 0;
1238 signum = SIGSTOP;
1239
1240 for (;;) {
1241 /* Stop here until moved to the foreground. */
1242
1243 tc_pgid = tcgetpgrp(STDOUT_FILENO);
1244 if (tc_pgid != man_pgid) {
1245 if (tc_pgid == pager_pid) {
1246 (void)tcsetpgrp(STDOUT_FILENO, man_pgid);
1247 if (signum == SIGTTIN)
1248 continue;
1249 } else
1250 outst->tag_files->tcpgid = tc_pgid;
1251 kill(0, signum);
1252 continue;
1253 }
1254
1255 /* Once in the foreground, activate the pager. */
1256
1257 if (pager_pid) {
1258 (void)tcsetpgrp(STDOUT_FILENO, pager_pid);
1259 kill(pager_pid, SIGCONT);
1260 } else
1261 pager_pid = spawn_pager(outst, tag_target);
1262
1263 /* Wait for the pager to stop or exit. */
1264
1265 while ((wait_pid = waitpid(pager_pid, &status,
1266 WUNTRACED)) == -1 && errno == EINTR)
1267 continue;
1268
1269 if (wait_pid == -1) {
1270 mandoc_msg(MANDOCERR_WAIT, 0, 0,
1271 "%s", strerror(errno));
1272 break;
1273 }
1274 if (!WIFSTOPPED(status))
1275 break;
1276
1277 signum = WSTOPSIG(status);
1278 }
1279 }
1280
1281 static pid_t
1282 spawn_pager(struct outstate *outst, char *tag_target)
1283 {
1284 const struct timespec timeout = { 0, 100000000 }; /* 0.1s */
1285 #define MAX_PAGER_ARGS 16
1286 char *argv[MAX_PAGER_ARGS];
1287 const char *pager;
1288 char *cp;
1289 size_t wordlen;
1290 #if HAVE_LESS_T
1291 size_t cmdlen;
1292 #endif
1293 int argc, use_ofn;
1294 pid_t pager_pid;
1295
1296 assert(outst->tag_files->ofd == -1);
1297 assert(outst->tag_files->tfs == NULL);
1298
1299 pager = getenv("MANPAGER");
1300 if (pager == NULL || *pager == '\0')
1301 pager = getenv("PAGER");
1302 if (pager == NULL || *pager == '\0')
1303 pager = BINM_PAGER;
1304
1305 /*
1306 * Parse the pager command into words.
1307 * Intentionally do not do anything fancy here.
1308 */
1309
1310 argc = 0;
1311 while (*pager != '\0' && argc + 5 < MAX_PAGER_ARGS) {
1312 wordlen = strcspn(pager, " ");
1313 argv[argc++] = mandoc_strndup(pager, wordlen);
1314 pager += wordlen;
1315 while (*pager == ' ')
1316 pager++;
1317 }
1318
1319 /* For less(1), use the tag file. */
1320
1321 use_ofn = 1;
1322 #if HAVE_LESS_T
1323 if (*outst->tag_files->tfn != '\0' &&
1324 (cmdlen = strlen(argv[0])) >= 4) {
1325 cp = argv[0] + cmdlen - 4;
1326 if (strcmp(cp, "less") == 0) {
1327 argv[argc++] = mandoc_strdup("-T");
1328 argv[argc++] = mandoc_strdup(outst->tag_files->tfn);
1329 if (tag_target != NULL) {
1330 argv[argc++] = mandoc_strdup("-t");
1331 argv[argc++] = mandoc_strdup(tag_target);
1332 use_ofn = 0;
1333 }
1334 }
1335 }
1336 #endif
1337 if (use_ofn) {
1338 if (outst->outtype == OUTT_HTML && tag_target != NULL)
1339 mandoc_asprintf(&argv[argc], "file://%s#%s",
1340 outst->tag_files->ofn, tag_target);
1341 else
1342 argv[argc] = mandoc_strdup(outst->tag_files->ofn);
1343 argc++;
1344 }
1345 argv[argc] = NULL;
1346
1347 switch (pager_pid = fork()) {
1348 case -1:
1349 mandoc_msg(MANDOCERR_FORK, 0, 0, "%s", strerror(errno));
1350 exit(mandoc_msg_getrc());
1351 case 0:
1352 break;
1353 default:
1354 while (argc > 0)
1355 free(argv[--argc]);
1356 (void)setpgid(pager_pid, 0);
1357 (void)tcsetpgrp(STDOUT_FILENO, pager_pid);
1358 #if HAVE_PLEDGE
1359 if (pledge("stdio rpath tmppath tty proc", NULL) == -1) {
1360 mandoc_msg(MANDOCERR_PLEDGE, 0, 0,
1361 "%s", strerror(errno));
1362 exit(mandoc_msg_getrc());
1363 }
1364 #endif
1365 outst->tag_files->pager_pid = pager_pid;
1366 return pager_pid;
1367 }
1368
1369 /*
1370 * The child process becomes the pager.
1371 * Do not start it before controlling the terminal.
1372 */
1373
1374 while (tcgetpgrp(STDOUT_FILENO) != getpid())
1375 nanosleep(&timeout, NULL);
1376
1377 execvp(argv[0], argv);
1378 mandoc_msg(MANDOCERR_EXEC, 0, 0, "%s: %s", argv[0], strerror(errno));
1379 _exit(mandoc_msg_getrc());
1380 }
A git conversion mirror of mandoc.bsd.lv