]>
git.cameronkatri.com Git - mandoc.git/blob - main.c
1 /* $Id: main.c,v 1.205 2014/12/11 19:19:35 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
;
118 struct manpage
*res
, *resp
;
119 char *conf_file
, *defpaths
;
121 int prio
, best_prio
, synopsis_only
;
125 enum outmode outmode
;
132 progname
= strrchr(argv
[0], '/');
133 if (progname
== NULL
)
139 if (strcmp(progname
, BINM_MAKEWHATIS
) == 0)
140 return(mandocdb(argc
, argv
));
143 /* Search options. */
145 memset(&paths
, 0, sizeof(struct manpaths
));
147 conf_file
= defpaths
= NULL
;
151 memset(&search
, 0, sizeof(struct mansearch
));
152 search
.outkey
= "Nd";
154 if (strcmp(progname
, BINM_MAN
) == 0)
155 search
.argmode
= ARG_NAME
;
156 else if (strcmp(progname
, BINM_APROPOS
) == 0)
157 search
.argmode
= ARG_EXPR
;
158 else if (strcmp(progname
, BINM_WHATIS
) == 0)
159 search
.argmode
= ARG_WORD
;
160 else if (strncmp(progname
, "help", 4) == 0)
161 search
.argmode
= ARG_NAME
;
163 search
.argmode
= ARG_FILE
;
165 /* Parser and formatter options. */
167 memset(&curp
, 0, sizeof(struct curparse
));
168 curp
.outtype
= OUTT_LOCALE
;
169 curp
.wlevel
= MANDOCLEVEL_FATAL
;
170 options
= MPARSE_SO
| MPARSE_UTF8
| MPARSE_LATIN1
;
178 outmode
= OUTMODE_DEF
;
180 while (-1 != (c
= getopt(argc
, argv
,
181 "aC:cfhI:iK:klM:m:O:S:s:T:VW:w"))) {
184 outmode
= OUTMODE_ALL
;
195 search
.argmode
= ARG_WORD
;
198 (void)strlcat(curp
.outopts
, "synopsis,", BUFSIZ
);
203 outmode
= OUTMODE_ALL
;
206 if (strncmp(optarg
, "os=", 3)) {
208 "%s: -I%s: Bad argument\n",
210 return((int)MANDOCLEVEL_BADARG
);
214 "%s: -I%s: Duplicate argument\n",
216 return((int)MANDOCLEVEL_BADARG
);
218 defos
= mandoc_strdup(optarg
+ 3);
221 outmode
= OUTMODE_INT
;
224 if ( ! koptions(&options
, optarg
))
225 return((int)MANDOCLEVEL_BADARG
);
228 search
.argmode
= ARG_EXPR
;
231 search
.argmode
= ARG_FILE
;
232 outmode
= OUTMODE_ALL
;
243 search
.outkey
= optarg
;
244 (void)strlcat(curp
.outopts
, optarg
, BUFSIZ
);
245 (void)strlcat(curp
.outopts
, ",", BUFSIZ
);
248 search
.arch
= optarg
;
254 if ( ! toptions(&curp
, optarg
))
255 return((int)MANDOCLEVEL_BADARG
);
258 if ( ! woptions(&curp
, optarg
))
259 return((int)MANDOCLEVEL_BADARG
);
262 outmode
= OUTMODE_FLN
;
274 usage(search
.argmode
);
276 /* Postprocess options. */
278 if (outmode
== OUTMODE_DEF
) {
279 switch (search
.argmode
) {
281 outmode
= OUTMODE_ALL
;
285 outmode
= OUTMODE_ONE
;
288 outmode
= OUTMODE_LST
;
293 /* Parse arguments. */
303 * and for a man(1) section argument without -s.
306 if (search
.argmode
== ARG_NAME
) {
307 if (*progname
== 'h') {
312 } else if (argv
[0] != NULL
&&
313 isdigit((unsigned char)argv
[0][0]) &&
314 (argv
[0][1] == '\0' || !strcmp(argv
[0], "3p"))) {
315 search
.sec
= argv
[0];
323 /* man(1), whatis(1), apropos(1) */
325 if (search
.argmode
!= ARG_FILE
) {
328 usage(search
.argmode
);
330 if (search
.argmode
== ARG_NAME
&&
331 outmode
== OUTMODE_ONE
)
332 search
.firstmatch
= 1;
334 /* Access the mandoc database. */
336 manpath_parse(&paths
, conf_file
, defpaths
, auxpaths
);
338 if( ! mansearch(&search
, &paths
, argc
, argv
, &res
, &sz
))
339 usage(search
.argmode
);
343 if (search
.argmode
== ARG_NAME
)
344 fprintf(stderr
, "%s: No entry for %s "
345 "in the manual.\n", progname
, argv
[0]);
346 rc
= MANDOCLEVEL_BADARG
;
351 * For standard man(1) and -a output mode,
352 * prepare for copying filename pointers
353 * into the program parameter array.
356 if (outmode
== OUTMODE_ONE
) {
359 } else if (outmode
== OUTMODE_ALL
)
362 /* Iterate all matching manuals. */
364 for (i
= 0; i
< sz
; i
++) {
365 if (outmode
== OUTMODE_FLN
)
367 else if (outmode
== OUTMODE_LST
)
368 printf("%s - %s\n", res
[i
].names
,
369 res
[i
].output
== NULL
? "" :
371 else if (outmode
== OUTMODE_ONE
) {
372 /* Search for the best section. */
373 isec
= strcspn(res
[i
].file
, "123456789");
374 sec
= res
[i
].file
[isec
];
377 prio
= sec_prios
[sec
- '1'];
378 if (prio
>= best_prio
)
386 * For man(1), -a and -i output mode, fall through
387 * to the main mandoc(1) code iterating files
388 * and running the parsers on each of them.
391 if (outmode
== OUTMODE_FLN
|| outmode
== OUTMODE_LST
)
394 fputs("mandoc: database support not compiled in\n",
396 return((int)MANDOCLEVEL_BADARG
);
402 if ( ! moptions(&options
, auxpaths
))
403 return((int)MANDOCLEVEL_BADARG
);
405 if (use_pager
&& isatty(STDOUT_FILENO
))
408 curp
.mchars
= mchars_alloc();
409 curp
.mp
= mparse_alloc(options
, curp
.wlevel
, mmsg
,
413 * Conditionally start up the lookaside buffer before parsing.
415 if (OUTT_MAN
== curp
.outtype
)
416 mparse_keep(curp
.mp
);
419 parse(&curp
, STDIN_FILENO
, "<stdin>", &rc
);
424 rc
= mparse_open(curp
.mp
, &fd
, resp
->file
);
427 else if (resp
->form
& FORM_SRC
) {
428 /* For .so only; ignore failure. */
429 chdir(paths
.paths
[resp
->ipath
]);
430 parse(&curp
, fd
, resp
->file
, &rc
);
432 rc
= passthrough(resp
->file
, fd
,
438 rc
= mparse_open(curp
.mp
, &fd
, *argv
++);
440 parse(&curp
, fd
, argv
[-1], &rc
);
443 if (mparse_wait(curp
.mp
) != MANDOCLEVEL_OK
)
444 rc
= MANDOCLEVEL_SYSERR
;
446 if (MANDOCLEVEL_OK
!= rc
&& curp
.wstop
)
452 (*curp
.outfree
)(curp
.outdata
);
453 mparse_free(curp
.mp
);
454 mchars_free(curp
.mchars
);
458 if (search
.argmode
!= ARG_FILE
) {
459 manpath_free(&paths
);
460 mansearch_free(res
, sz
);
474 printf("mandoc %s\n", VERSION
);
475 exit((int)MANDOCLEVEL_OK
);
479 usage(enum argmode argmode
)
484 fputs("usage: mandoc [-acfhklV] [-Ios=name] "
485 "[-Kencoding] [-mformat] [-Ooption]\n"
486 "\t [-Toutput] [-Wlevel] [file ...]\n", stderr
);
489 fputs("usage: man [-acfhklVw] [-C file] "
490 "[-M path] [-m path] [-S arch] [-s section]\n"
491 "\t [section] name ...\n", stderr
);
494 fputs("usage: whatis [-acfhklVw] [-C file] "
495 "[-M path] [-m path] [-O outkey] [-S arch]\n"
496 "\t [-s section] name ...\n", stderr
);
499 fputs("usage: apropos [-acfhklVw] [-C file] "
500 "[-M path] [-m path] [-O outkey] [-S arch]\n"
501 "\t [-s section] expression ...\n", stderr
);
504 exit((int)MANDOCLEVEL_BADARG
);
508 parse(struct curparse
*curp
, int fd
, const char *file
,
509 enum mandoclevel
*level
)
515 /* Begin by parsing the file itself. */
520 rc
= mparse_readfd(curp
->mp
, fd
, file
);
522 /* Stop immediately if the parse has failed. */
524 if (MANDOCLEVEL_FATAL
<= rc
)
528 * With -Wstop and warnings or errors of at least the requested
529 * level, do not produce output.
532 if (MANDOCLEVEL_OK
!= rc
&& curp
->wstop
)
535 /* If unset, allocate output dev now (if applicable). */
537 if ( ! (curp
->outman
&& curp
->outmdoc
)) {
538 switch (curp
->outtype
) {
540 curp
->outdata
= html_alloc(curp
->mchars
,
542 curp
->outfree
= html_free
;
545 curp
->outdata
= utf8_alloc(curp
->mchars
,
547 curp
->outfree
= ascii_free
;
550 curp
->outdata
= locale_alloc(curp
->mchars
,
552 curp
->outfree
= ascii_free
;
555 curp
->outdata
= ascii_alloc(curp
->mchars
,
557 curp
->outfree
= ascii_free
;
560 curp
->outdata
= pdf_alloc(curp
->mchars
,
562 curp
->outfree
= pspdf_free
;
565 curp
->outdata
= ps_alloc(curp
->mchars
,
567 curp
->outfree
= pspdf_free
;
573 switch (curp
->outtype
) {
575 curp
->outman
= html_man
;
576 curp
->outmdoc
= html_mdoc
;
579 curp
->outman
= tree_man
;
580 curp
->outmdoc
= tree_mdoc
;
583 curp
->outmdoc
= man_mdoc
;
584 curp
->outman
= man_man
;
595 curp
->outman
= terminal_man
;
596 curp
->outmdoc
= terminal_mdoc
;
603 mparse_result(curp
->mp
, &mdoc
, &man
, NULL
);
605 /* Execute the out device, if it exists. */
607 if (man
&& curp
->outman
)
608 (*curp
->outman
)(curp
->outdata
, man
);
609 if (mdoc
&& curp
->outmdoc
)
610 (*curp
->outmdoc
)(curp
->outdata
, mdoc
);
614 mparse_reset(curp
->mp
);
621 static enum mandoclevel
622 passthrough(const char *file
, int fd
, int synopsis_only
)
624 const char synb
[] = "S\bSY\bYN\bNO\bOP\bPS\bSI\bIS\bS";
625 const char synr
[] = "SYNOPSIS";
634 if ((stream
= fdopen(fd
, "r")) == NULL
) {
641 while ((line
= fgetln(stream
, &len
)) != NULL
) {
644 if ( ! isspace((unsigned char)*line
))
647 isspace((unsigned char)*line
)) {
652 if ((len
== sizeof(synb
) &&
653 ! strncmp(line
, synb
, len
- 1)) ||
654 (len
== sizeof(synr
) &&
655 ! strncmp(line
, synr
, len
- 1)))
660 for (off
= 0; off
< len
; off
+= nw
)
661 if ((nw
= write(STDOUT_FILENO
, line
+ off
,
662 len
- off
)) == -1 || nw
== 0) {
669 if (ferror(stream
)) {
677 return(MANDOCLEVEL_OK
);
680 fprintf(stderr
, "%s: %s: SYSERR: %s: %s",
681 progname
, file
, syscall
, strerror(errno
));
682 return(MANDOCLEVEL_SYSERR
);
687 koptions(int *options
, char *arg
)
690 if ( ! strcmp(arg
, "utf-8")) {
691 *options
|= MPARSE_UTF8
;
692 *options
&= ~MPARSE_LATIN1
;
693 } else if ( ! strcmp(arg
, "iso-8859-1")) {
694 *options
|= MPARSE_LATIN1
;
695 *options
&= ~MPARSE_UTF8
;
696 } else if ( ! strcmp(arg
, "us-ascii")) {
697 *options
&= ~(MPARSE_UTF8
| MPARSE_LATIN1
);
699 fprintf(stderr
, "%s: -K%s: Bad argument\n",
707 moptions(int *options
, char *arg
)
712 else if (0 == strcmp(arg
, "doc"))
713 *options
|= MPARSE_MDOC
;
714 else if (0 == strcmp(arg
, "andoc"))
716 else if (0 == strcmp(arg
, "an"))
717 *options
|= MPARSE_MAN
;
719 fprintf(stderr
, "%s: -m%s: Bad argument\n",
728 toptions(struct curparse
*curp
, char *arg
)
731 if (0 == strcmp(arg
, "ascii"))
732 curp
->outtype
= OUTT_ASCII
;
733 else if (0 == strcmp(arg
, "lint")) {
734 curp
->outtype
= OUTT_LINT
;
735 curp
->wlevel
= MANDOCLEVEL_WARNING
;
736 } else if (0 == strcmp(arg
, "tree"))
737 curp
->outtype
= OUTT_TREE
;
738 else if (0 == strcmp(arg
, "man"))
739 curp
->outtype
= OUTT_MAN
;
740 else if (0 == strcmp(arg
, "html"))
741 curp
->outtype
= OUTT_HTML
;
742 else if (0 == strcmp(arg
, "utf8"))
743 curp
->outtype
= OUTT_UTF8
;
744 else if (0 == strcmp(arg
, "locale"))
745 curp
->outtype
= OUTT_LOCALE
;
746 else if (0 == strcmp(arg
, "xhtml"))
747 curp
->outtype
= OUTT_HTML
;
748 else if (0 == strcmp(arg
, "ps"))
749 curp
->outtype
= OUTT_PS
;
750 else if (0 == strcmp(arg
, "pdf"))
751 curp
->outtype
= OUTT_PDF
;
753 fprintf(stderr
, "%s: -T%s: Bad argument\n",
762 woptions(struct curparse
*curp
, char *arg
)
776 switch (getsubopt(&arg
, UNCONST(toks
), &v
)) {
783 curp
->wlevel
= MANDOCLEVEL_WARNING
;
786 curp
->wlevel
= MANDOCLEVEL_ERROR
;
789 curp
->wlevel
= MANDOCLEVEL_FATAL
;
792 fprintf(stderr
, "%s: -W%s: Bad argument\n",
802 mmsg(enum mandocerr t
, enum mandoclevel lvl
,
803 const char *file
, int line
, int col
, const char *msg
)
805 const char *mparse_msg
;
807 fprintf(stderr
, "%s: %s:", progname
, file
);
810 fprintf(stderr
, "%d:%d:", line
, col
+ 1);
812 fprintf(stderr
, " %s", mparse_strlevel(lvl
));
814 if (NULL
!= (mparse_msg
= mparse_strerror(t
)))
815 fprintf(stderr
, ": %s", mparse_msg
);
818 fprintf(stderr
, ": %s", msg
);
826 #define MAX_PAGER_ARGS 16
827 char *argv
[MAX_PAGER_ARGS
];
833 if (pipe(fildes
) == -1) {
834 fprintf(stderr
, "%s: pipe: %s\n",
835 progname
, strerror(errno
));
841 fprintf(stderr
, "%s: fork: %s\n",
842 progname
, strerror(errno
));
843 exit((int)MANDOCLEVEL_SYSERR
);
846 if (dup2(fildes
[1], STDOUT_FILENO
) == -1) {
847 fprintf(stderr
, "%s: dup output: %s\n",
848 progname
, strerror(errno
));
849 exit((int)MANDOCLEVEL_SYSERR
);
856 /* The original process becomes the pager. */
859 if (dup2(fildes
[0], STDIN_FILENO
) == -1) {
860 fprintf(stderr
, "%s: dup input: %s\n",
861 progname
, strerror(errno
));
862 exit((int)MANDOCLEVEL_SYSERR
);
865 pager
= getenv("MANPAGER");
866 if (pager
== NULL
|| *pager
== '\0')
867 pager
= getenv("PAGER");
868 if (pager
== NULL
|| *pager
== '\0')
869 pager
= "/usr/bin/more -s";
870 cp
= mandoc_strdup(pager
);
873 * Parse the pager command into words.
874 * Intentionally do not do anything fancy here.
878 while (argc
+ 1 < MAX_PAGER_ARGS
) {
880 cp
= strchr(cp
, ' ');
891 /* Hand over to the pager. */
893 execvp(argv
[0], argv
);
894 fprintf(stderr
, "%s: exec: %s\n",
895 progname
, strerror(errno
));
896 exit((int)MANDOCLEVEL_SYSERR
);