Annotation of mandoc/man.h, Revision 1.71
1.71 ! schwarze 1: /* $Id: man.h,v 1.70 2015/04/02 21:36:49 schwarze Exp $ */
1.1 kristaps 2: /*
1.54 schwarze 3: * Copyright (c) 2009, 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv>
1.71 ! schwarze 4: * Copyright (c) 2014, 2015 Ingo Schwarze <schwarze@openbsd.org>
1.1 kristaps 5: *
6: * Permission to use, copy, modify, and distribute this software for any
1.11 kristaps 7: * purpose with or without fee is hereby granted, provided that the above
8: * copyright notice and this permission notice appear in all copies.
1.1 kristaps 9: *
1.71 ! schwarze 10: * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHORS DISCLAIM ALL WARRANTIES
1.11 kristaps 11: * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
1.71 ! schwarze 12: * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR
1.11 kristaps 13: * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
14: * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
15: * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
16: * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
1.1 kristaps 17: */
18:
1.71 ! schwarze 19: #define MAN_br 0
! 20: #define MAN_TH 1
! 21: #define MAN_SH 2
! 22: #define MAN_SS 3
! 23: #define MAN_TP 4
! 24: #define MAN_LP 5
! 25: #define MAN_PP 6
! 26: #define MAN_P 7
! 27: #define MAN_IP 8
! 28: #define MAN_HP 9
! 29: #define MAN_SM 10
! 30: #define MAN_SB 11
! 31: #define MAN_BI 12
! 32: #define MAN_IB 13
! 33: #define MAN_BR 14
! 34: #define MAN_RB 15
! 35: #define MAN_R 16
! 36: #define MAN_B 17
! 37: #define MAN_I 18
! 38: #define MAN_IR 19
! 39: #define MAN_RI 20
! 40: #define MAN_sp 21
! 41: #define MAN_nf 22
! 42: #define MAN_fi 23
! 43: #define MAN_RE 24
! 44: #define MAN_RS 25
! 45: #define MAN_DT 26
! 46: #define MAN_UC 27
! 47: #define MAN_PD 28
! 48: #define MAN_AT 29
! 49: #define MAN_in 30
! 50: #define MAN_ft 31
! 51: #define MAN_OP 32
! 52: #define MAN_EX 33
! 53: #define MAN_EE 34
! 54: #define MAN_UR 35
! 55: #define MAN_UE 36
! 56: #define MAN_ll 37
! 57: #define MAN_MAX 38
1.1 kristaps 58:
1.45 kristaps 59: struct man_meta {
60: char *msec; /* `TH' section (1, 3p, etc.) */
1.54 schwarze 61: char *date; /* `TH' normalised date */
1.45 kristaps 62: char *vol; /* `TH' volume */
63: char *title; /* `TH' title (e.g., FOO) */
64: char *source; /* `TH' source (e.g., GNU) */
1.65 schwarze 65: int hasbody; /* document is not empty */
1.45 kristaps 66: };
67:
1.71 ! schwarze 68: /* Names of macros. */
1.1 kristaps 69: extern const char *const *man_macronames;
70:
71: __BEGIN_DECLS
72:
73: struct man;
74:
1.71 ! schwarze 75: const struct roff_node *man_node(const struct man *);
1.1 kristaps 76: const struct man_meta *man_meta(const struct man *);
1.59 kristaps 77: const struct mparse *man_mparse(const struct man *);
1.71 ! schwarze 78: void man_deroff(char **, const struct roff_node *);
1.1 kristaps 79:
80: __END_DECLS
CVSweb