]>
git.cameronkatri.com Git - mandoc.git/blob - main.c
5f8e2680e6650b1733ea28a45b179a33fbb5c0b8
1 /* $Id: main.c,v 1.211 2015/01/01 13:20:38 schwarze Exp $ */
3 * Copyright (c) 2008-2012 Kristaps Dzonsons <kristaps@bsd.lv>
4 * Copyright (c) 2010, 2011, 2012, 2014 Ingo Schwarze <schwarze@openbsd.org>
5 * Copyright (c) 2010 Joerg Sonnenberger <joerg@netbsd.org>
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.
11 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
12 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
13 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR 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.
21 #include <sys/types.h>
34 #include "mandoc_aux.h"
39 #include "mansearch.h"
41 #if !defined(__GNUC__) || (__GNUC__ < 2)
43 # define __attribute__(x)
45 #endif /* !defined(__GNUC__) || (__GNUC__ < 2) */
56 typedef void (*out_mdoc
)(void *, const struct mdoc
*);
57 typedef void (*out_man
)(void *, const struct man
*);
58 typedef void (*out_free
)(void *);
61 OUTT_ASCII
= 0, /* -Tascii */
62 OUTT_LOCALE
, /* -Tlocale */
63 OUTT_UTF8
, /* -Tutf8 */
64 OUTT_TREE
, /* -Ttree */
66 OUTT_HTML
, /* -Thtml */
67 OUTT_LINT
, /* -Tlint */
74 struct mchars
*mchars
; /* character table */
75 enum mandoclevel wlevel
; /* ignore messages below this */
76 int wstop
; /* stop after a file with a warning */
77 enum outt outtype
; /* which output to use */
78 out_mdoc outmdoc
; /* mdoc output ptr */
79 out_man outman
; /* man output ptr */
80 out_free outfree
; /* free output ptr */
81 void *outdata
; /* data for output */
82 char outopts
[BUFSIZ
]; /* buf of output opts */
85 static int koptions(int *, char *);
87 int mandocdb(int, char**);
89 static int moptions(int *, char *);
90 static void mmsg(enum mandocerr
, enum mandoclevel
,
91 const char *, int, int, const char *);
92 static void parse(struct curparse
*, int,
93 const char *, enum mandoclevel
*);
95 static enum mandoclevel
passthrough(const char *, int, int);
97 static void spawn_pager(void);
98 static int toptions(struct curparse
*, char *);
99 static void usage(enum argmode
) __attribute__((noreturn
));
100 static void version(void) __attribute__((noreturn
));
101 static int woptions(struct curparse
*, char *);
103 static const int sec_prios
[] = {1, 4, 5, 8, 6, 3, 7, 2, 9};
104 static char help_arg
[] = "help";
105 static char *help_argv
[] = {help_arg
, NULL
};
106 static const char *progname
;
110 main(int argc
, char *argv
[])
112 struct curparse curp
;
113 struct mansearch search
;
114 struct manpaths paths
;
119 struct manpage
*res
, *resp
;
120 char *conf_file
, *defpaths
;
122 int prio
, best_prio
, synopsis_only
;
126 enum outmode outmode
;
133 progname
= strrchr(argv
[0], '/');
134 if (progname
== NULL
)
140 if (strcmp(progname
, BINM_MAKEWHATIS
) == 0)
141 return(mandocdb(argc
, argv
));
144 /* Search options. */
146 memset(&paths
, 0, sizeof(struct manpaths
));
148 conf_file
= defpaths
= NULL
;
152 memset(&search
, 0, sizeof(struct mansearch
));
153 search
.outkey
= "Nd";
155 if (strcmp(progname
, BINM_MAN
) == 0)
156 search
.argmode
= ARG_NAME
;
157 else if (strcmp(progname
, BINM_APROPOS
) == 0)
158 search
.argmode
= ARG_EXPR
;
159 else if (strcmp(progname
, BINM_WHATIS
) == 0)
160 search
.argmode
= ARG_WORD
;
161 else if (strncmp(progname
, "help", 4) == 0)
162 search
.argmode
= ARG_NAME
;
164 search
.argmode
= ARG_FILE
;
166 /* Parser and formatter options. */
168 memset(&curp
, 0, sizeof(struct curparse
));
169 curp
.outtype
= OUTT_LOCALE
;
170 curp
.wlevel
= MANDOCLEVEL_FATAL
;
171 options
= MPARSE_SO
| MPARSE_UTF8
| MPARSE_LATIN1
;
179 outmode
= OUTMODE_DEF
;
181 while (-1 != (c
= getopt(argc
, argv
,
182 "aC:cfhI:iK:klM:m:O:S:s:T:VW:w"))) {
185 outmode
= OUTMODE_ALL
;
196 search
.argmode
= ARG_WORD
;
199 (void)strlcat(curp
.outopts
, "synopsis,", BUFSIZ
);
204 outmode
= OUTMODE_ALL
;
207 if (strncmp(optarg
, "os=", 3)) {
209 "%s: -I %s: Bad argument\n",
211 return((int)MANDOCLEVEL_BADARG
);
215 "%s: -I %s: Duplicate argument\n",
217 return((int)MANDOCLEVEL_BADARG
);
219 defos
= mandoc_strdup(optarg
+ 3);
222 outmode
= OUTMODE_INT
;
225 if ( ! koptions(&options
, optarg
))
226 return((int)MANDOCLEVEL_BADARG
);
229 search
.argmode
= ARG_EXPR
;
232 search
.argmode
= ARG_FILE
;
233 outmode
= OUTMODE_ALL
;
244 search
.outkey
= optarg
;
245 (void)strlcat(curp
.outopts
, optarg
, BUFSIZ
);
246 (void)strlcat(curp
.outopts
, ",", BUFSIZ
);
249 search
.arch
= optarg
;
255 if ( ! toptions(&curp
, optarg
))
256 return((int)MANDOCLEVEL_BADARG
);
259 if ( ! woptions(&curp
, optarg
))
260 return((int)MANDOCLEVEL_BADARG
);
263 outmode
= OUTMODE_FLN
;
275 usage(search
.argmode
);
277 /* Postprocess options. */
279 if (outmode
== OUTMODE_DEF
) {
280 switch (search
.argmode
) {
282 outmode
= OUTMODE_ALL
;
286 outmode
= OUTMODE_ONE
;
289 outmode
= OUTMODE_LST
;
294 /* Parse arguments. */
304 * and for a man(1) section argument without -s.
307 if (search
.argmode
== ARG_NAME
) {
308 if (*progname
== 'h') {
313 } else if (argc
> 1 &&
314 ((uc
= argv
[0]) != NULL
) &&
315 ((isdigit(uc
[0]) && (uc
[1] == '\0' ||
316 (isalpha(uc
[1]) && uc
[2] == '\0'))) ||
317 (uc
[0] == 'n' && uc
[1] == '\0'))) {
326 /* man(1), whatis(1), apropos(1) */
328 if (search
.argmode
!= ARG_FILE
) {
331 usage(search
.argmode
);
333 if (search
.argmode
== ARG_NAME
&&
334 outmode
== OUTMODE_ONE
)
335 search
.firstmatch
= 1;
337 /* Access the mandoc database. */
339 manpath_parse(&paths
, conf_file
, defpaths
, auxpaths
);
341 if( ! mansearch(&search
, &paths
, argc
, argv
, &res
, &sz
))
342 usage(search
.argmode
);
346 if (search
.argmode
== ARG_NAME
)
347 fprintf(stderr
, "%s: No entry for %s "
348 "in the manual.\n", progname
, argv
[0]);
349 rc
= MANDOCLEVEL_BADARG
;
354 * For standard man(1) and -a output mode,
355 * prepare for copying filename pointers
356 * into the program parameter array.
359 if (outmode
== OUTMODE_ONE
) {
362 } else if (outmode
== OUTMODE_ALL
)
365 /* Iterate all matching manuals. */
367 for (i
= 0; i
< sz
; i
++) {
368 if (outmode
== OUTMODE_FLN
)
370 else if (outmode
== OUTMODE_LST
)
371 printf("%s - %s\n", res
[i
].names
,
372 res
[i
].output
== NULL
? "" :
374 else if (outmode
== OUTMODE_ONE
) {
375 /* Search for the best section. */
376 isec
= strcspn(res
[i
].file
, "123456789");
377 sec
= res
[i
].file
[isec
];
380 prio
= sec_prios
[sec
- '1'];
381 if (prio
>= best_prio
)
389 * For man(1), -a and -i output mode, fall through
390 * to the main mandoc(1) code iterating files
391 * and running the parsers on each of them.
394 if (outmode
== OUTMODE_FLN
|| outmode
== OUTMODE_LST
)
397 fputs("mandoc: database support not compiled in\n",
399 return((int)MANDOCLEVEL_BADARG
);
405 if (search
.argmode
== ARG_FILE
&& ! moptions(&options
, auxpaths
))
406 return((int)MANDOCLEVEL_BADARG
);
408 if (use_pager
&& isatty(STDOUT_FILENO
))
411 curp
.mchars
= mchars_alloc();
412 curp
.mp
= mparse_alloc(options
, curp
.wlevel
, mmsg
,
416 * Conditionally start up the lookaside buffer before parsing.
418 if (OUTT_MAN
== curp
.outtype
)
419 mparse_keep(curp
.mp
);
422 parse(&curp
, STDIN_FILENO
, "<stdin>", &rc
);
427 rc
= mparse_open(curp
.mp
, &fd
, resp
->file
);
430 else if (resp
->form
& FORM_SRC
) {
431 /* For .so only; ignore failure. */
432 chdir(paths
.paths
[resp
->ipath
]);
433 parse(&curp
, fd
, resp
->file
, &rc
);
435 rc
= passthrough(resp
->file
, fd
,
441 rc
= mparse_open(curp
.mp
, &fd
, *argv
++);
443 parse(&curp
, fd
, argv
[-1], &rc
);
446 if (mparse_wait(curp
.mp
) != MANDOCLEVEL_OK
)
447 rc
= MANDOCLEVEL_SYSERR
;
449 if (MANDOCLEVEL_OK
!= rc
&& curp
.wstop
)
452 if (--argc
&& curp
.outtype
<= OUTT_UTF8
)
453 ascii_sepline(curp
.outdata
);
457 (*curp
.outfree
)(curp
.outdata
);
458 mparse_free(curp
.mp
);
459 mchars_free(curp
.mchars
);
463 if (search
.argmode
!= ARG_FILE
) {
464 manpath_free(&paths
);
465 mansearch_free(res
, sz
);
479 printf("mandoc %s\n", VERSION
);
480 exit((int)MANDOCLEVEL_OK
);
484 usage(enum argmode argmode
)
489 fputs("usage: mandoc [-acfhklV] [-Ios=name] "
490 "[-Kencoding] [-mformat] [-Ooption]\n"
491 "\t [-Toutput] [-Wlevel] [file ...]\n", stderr
);
494 fputs("usage: man [-acfhklVw] [-C file] [-I os=name] "
495 "[-K encoding] [-M path] [-m path]\n"
496 "\t [-O option=value] [-S subsection] [-s section] "
497 "[-T output] [-W level]\n"
498 "\t [section] name ...\n", stderr
);
501 fputs("usage: whatis [-acfhklVw] [-C file] "
502 "[-M path] [-m path] [-O outkey] [-S arch]\n"
503 "\t [-s section] name ...\n", stderr
);
506 fputs("usage: apropos [-acfhklVw] [-C file] "
507 "[-M path] [-m path] [-O outkey] [-S arch]\n"
508 "\t [-s section] expression ...\n", stderr
);
511 exit((int)MANDOCLEVEL_BADARG
);
515 parse(struct curparse
*curp
, int fd
, const char *file
,
516 enum mandoclevel
*level
)
522 /* Begin by parsing the file itself. */
527 rc
= mparse_readfd(curp
->mp
, fd
, file
);
529 /* Stop immediately if the parse has failed. */
531 if (MANDOCLEVEL_FATAL
<= rc
)
535 * With -Wstop and warnings or errors of at least the requested
536 * level, do not produce output.
539 if (MANDOCLEVEL_OK
!= rc
&& curp
->wstop
)
542 /* If unset, allocate output dev now (if applicable). */
544 if ( ! (curp
->outman
&& curp
->outmdoc
)) {
545 switch (curp
->outtype
) {
547 curp
->outdata
= html_alloc(curp
->mchars
,
549 curp
->outfree
= html_free
;
552 curp
->outdata
= utf8_alloc(curp
->mchars
,
554 curp
->outfree
= ascii_free
;
557 curp
->outdata
= locale_alloc(curp
->mchars
,
559 curp
->outfree
= ascii_free
;
562 curp
->outdata
= ascii_alloc(curp
->mchars
,
564 curp
->outfree
= ascii_free
;
567 curp
->outdata
= pdf_alloc(curp
->mchars
,
569 curp
->outfree
= pspdf_free
;
572 curp
->outdata
= ps_alloc(curp
->mchars
,
574 curp
->outfree
= pspdf_free
;
580 switch (curp
->outtype
) {
582 curp
->outman
= html_man
;
583 curp
->outmdoc
= html_mdoc
;
586 curp
->outman
= tree_man
;
587 curp
->outmdoc
= tree_mdoc
;
590 curp
->outmdoc
= man_mdoc
;
591 curp
->outman
= man_man
;
602 curp
->outman
= terminal_man
;
603 curp
->outmdoc
= terminal_mdoc
;
610 mparse_result(curp
->mp
, &mdoc
, &man
, NULL
);
612 /* Execute the out device, if it exists. */
614 if (man
&& curp
->outman
)
615 (*curp
->outman
)(curp
->outdata
, man
);
616 if (mdoc
&& curp
->outmdoc
)
617 (*curp
->outmdoc
)(curp
->outdata
, mdoc
);
621 mparse_reset(curp
->mp
);
628 static enum mandoclevel
629 passthrough(const char *file
, int fd
, int synopsis_only
)
631 const char synb
[] = "S\bSY\bYN\bNO\bOP\bPS\bSI\bIS\bS";
632 const char synr
[] = "SYNOPSIS";
643 if ((stream
= fdopen(fd
, "r")) == NULL
) {
650 while ((line
= fgetln(stream
, &len
)) != NULL
) {
653 if ( ! isspace((unsigned char)*line
))
656 isspace((unsigned char)*line
)) {
661 if ((len
== sizeof(synb
) &&
662 ! strncmp(line
, synb
, len
- 1)) ||
663 (len
== sizeof(synr
) &&
664 ! strncmp(line
, synr
, len
- 1)))
669 for (off
= 0; off
< len
; off
+= nw
)
670 if ((nw
= write(STDOUT_FILENO
, line
+ off
,
671 len
- off
)) == -1 || nw
== 0) {
678 if (ferror(stream
)) {
686 return(MANDOCLEVEL_OK
);
689 fprintf(stderr
, "%s: %s: SYSERR: %s: %s",
690 progname
, file
, syscall
, strerror(errno
));
691 return(MANDOCLEVEL_SYSERR
);
696 koptions(int *options
, char *arg
)
699 if ( ! strcmp(arg
, "utf-8")) {
700 *options
|= MPARSE_UTF8
;
701 *options
&= ~MPARSE_LATIN1
;
702 } else if ( ! strcmp(arg
, "iso-8859-1")) {
703 *options
|= MPARSE_LATIN1
;
704 *options
&= ~MPARSE_UTF8
;
705 } else if ( ! strcmp(arg
, "us-ascii")) {
706 *options
&= ~(MPARSE_UTF8
| MPARSE_LATIN1
);
708 fprintf(stderr
, "%s: -K %s: Bad argument\n",
716 moptions(int *options
, char *arg
)
721 else if (0 == strcmp(arg
, "doc"))
722 *options
|= MPARSE_MDOC
;
723 else if (0 == strcmp(arg
, "andoc"))
725 else if (0 == strcmp(arg
, "an"))
726 *options
|= MPARSE_MAN
;
728 fprintf(stderr
, "%s: -m %s: Bad argument\n",
737 toptions(struct curparse
*curp
, char *arg
)
740 if (0 == strcmp(arg
, "ascii"))
741 curp
->outtype
= OUTT_ASCII
;
742 else if (0 == strcmp(arg
, "lint")) {
743 curp
->outtype
= OUTT_LINT
;
744 curp
->wlevel
= MANDOCLEVEL_WARNING
;
745 } else if (0 == strcmp(arg
, "tree"))
746 curp
->outtype
= OUTT_TREE
;
747 else if (0 == strcmp(arg
, "man"))
748 curp
->outtype
= OUTT_MAN
;
749 else if (0 == strcmp(arg
, "html"))
750 curp
->outtype
= OUTT_HTML
;
751 else if (0 == strcmp(arg
, "utf8"))
752 curp
->outtype
= OUTT_UTF8
;
753 else if (0 == strcmp(arg
, "locale"))
754 curp
->outtype
= OUTT_LOCALE
;
755 else if (0 == strcmp(arg
, "xhtml"))
756 curp
->outtype
= OUTT_HTML
;
757 else if (0 == strcmp(arg
, "ps"))
758 curp
->outtype
= OUTT_PS
;
759 else if (0 == strcmp(arg
, "pdf"))
760 curp
->outtype
= OUTT_PDF
;
762 fprintf(stderr
, "%s: -T %s: Bad argument\n",
771 woptions(struct curparse
*curp
, char *arg
)
785 switch (getsubopt(&arg
, UNCONST(toks
), &v
)) {
792 curp
->wlevel
= MANDOCLEVEL_WARNING
;
795 curp
->wlevel
= MANDOCLEVEL_ERROR
;
798 curp
->wlevel
= MANDOCLEVEL_FATAL
;
801 fprintf(stderr
, "%s: -W %s: Bad argument\n",
811 mmsg(enum mandocerr t
, enum mandoclevel lvl
,
812 const char *file
, int line
, int col
, const char *msg
)
814 const char *mparse_msg
;
816 fprintf(stderr
, "%s: %s:", progname
, file
);
819 fprintf(stderr
, "%d:%d:", line
, col
+ 1);
821 fprintf(stderr
, " %s", mparse_strlevel(lvl
));
823 if (NULL
!= (mparse_msg
= mparse_strerror(t
)))
824 fprintf(stderr
, ": %s", mparse_msg
);
827 fprintf(stderr
, ": %s", msg
);
835 #define MAX_PAGER_ARGS 16
836 char *argv
[MAX_PAGER_ARGS
];
842 if (pipe(fildes
) == -1) {
843 fprintf(stderr
, "%s: pipe: %s\n",
844 progname
, strerror(errno
));
850 fprintf(stderr
, "%s: fork: %s\n",
851 progname
, strerror(errno
));
852 exit((int)MANDOCLEVEL_SYSERR
);
855 if (dup2(fildes
[1], STDOUT_FILENO
) == -1) {
856 fprintf(stderr
, "%s: dup output: %s\n",
857 progname
, strerror(errno
));
858 exit((int)MANDOCLEVEL_SYSERR
);
865 /* The original process becomes the pager. */
868 if (dup2(fildes
[0], STDIN_FILENO
) == -1) {
869 fprintf(stderr
, "%s: dup input: %s\n",
870 progname
, strerror(errno
));
871 exit((int)MANDOCLEVEL_SYSERR
);
874 pager
= getenv("MANPAGER");
875 if (pager
== NULL
|| *pager
== '\0')
876 pager
= getenv("PAGER");
877 if (pager
== NULL
|| *pager
== '\0')
878 pager
= "/usr/bin/more -s";
879 cp
= mandoc_strdup(pager
);
882 * Parse the pager command into words.
883 * Intentionally do not do anything fancy here.
887 while (argc
+ 1 < MAX_PAGER_ARGS
) {
889 cp
= strchr(cp
, ' ');
900 /* Hand over to the pager. */
902 execvp(argv
[0], argv
);
903 fprintf(stderr
, "%s: exec: %s\n",
904 progname
, strerror(errno
));
905 exit((int)MANDOCLEVEL_SYSERR
);