xref: /freebsd/contrib/mandoc/manconf.h (revision 6d38604fc532a3fc060788e3ce40464b46047eaf)
1*6d38604fSBaptiste Daroussin /* $OpenBSD: manconf.h,v 1.7 2018/11/22 11:30:15 schwarze Exp $ */
261d06d6bSBaptiste Daroussin /*
3*6d38604fSBaptiste Daroussin  * Copyright (c) 2011,2015,2017,2018,2020 Ingo Schwarze <schwarze@openbsd.org>
461d06d6bSBaptiste Daroussin  * Copyright (c) 2011 Kristaps Dzonsons <kristaps@bsd.lv>
561d06d6bSBaptiste Daroussin  *
661d06d6bSBaptiste Daroussin  * Permission to use, copy, modify, and distribute this software for any
761d06d6bSBaptiste Daroussin  * purpose with or without fee is hereby granted, provided that the above
861d06d6bSBaptiste Daroussin  * copyright notice and this permission notice appear in all copies.
961d06d6bSBaptiste Daroussin  *
1061d06d6bSBaptiste Daroussin  * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHORS DISCLAIM ALL WARRANTIES
1161d06d6bSBaptiste Daroussin  * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
1261d06d6bSBaptiste Daroussin  * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR
1361d06d6bSBaptiste Daroussin  * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
1461d06d6bSBaptiste Daroussin  * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
1561d06d6bSBaptiste Daroussin  * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
1661d06d6bSBaptiste Daroussin  * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
17*6d38604fSBaptiste Daroussin  *
18*6d38604fSBaptiste Daroussin  * Public interface to man(1) configuration management.
19*6d38604fSBaptiste Daroussin  * For use by the main program and by the formatters.
2061d06d6bSBaptiste Daroussin  */
2161d06d6bSBaptiste Daroussin 
2261d06d6bSBaptiste Daroussin /* List of unique, absolute paths to manual trees. */
2361d06d6bSBaptiste Daroussin 
2461d06d6bSBaptiste Daroussin struct	manpaths {
2561d06d6bSBaptiste Daroussin 	char	**paths;
2661d06d6bSBaptiste Daroussin 	size_t	  sz;
2761d06d6bSBaptiste Daroussin };
2861d06d6bSBaptiste Daroussin 
2961d06d6bSBaptiste Daroussin /* Data from -O options and man.conf(5) output directives. */
3061d06d6bSBaptiste Daroussin 
3161d06d6bSBaptiste Daroussin struct	manoutput {
3261d06d6bSBaptiste Daroussin 	char	 *includes;
3361d06d6bSBaptiste Daroussin 	char	 *man;
34*6d38604fSBaptiste Daroussin 	char	 *outfilename;
3561d06d6bSBaptiste Daroussin 	char	 *paper;
3661d06d6bSBaptiste Daroussin 	char	 *style;
377295610fSBaptiste Daroussin 	char	 *tag;
38*6d38604fSBaptiste Daroussin 	char	 *tagfilename;
3961d06d6bSBaptiste Daroussin 	size_t	  indent;
4061d06d6bSBaptiste Daroussin 	size_t	  width;
4161d06d6bSBaptiste Daroussin 	int	  fragment;
4261d06d6bSBaptiste Daroussin 	int	  mdoc;
4361d06d6bSBaptiste Daroussin 	int	  noval;
447295610fSBaptiste Daroussin 	int	  synopsisonly;
45*6d38604fSBaptiste Daroussin 	int	  tag_found;
467295610fSBaptiste Daroussin 	int	  toc;
4761d06d6bSBaptiste Daroussin };
4861d06d6bSBaptiste Daroussin 
4961d06d6bSBaptiste Daroussin struct	manconf {
5061d06d6bSBaptiste Daroussin 	struct manoutput	  output;
5161d06d6bSBaptiste Daroussin 	struct manpaths		  manpath;
5261d06d6bSBaptiste Daroussin };
5361d06d6bSBaptiste Daroussin 
5461d06d6bSBaptiste Daroussin 
5561d06d6bSBaptiste Daroussin void	 manconf_parse(struct manconf *, const char *, char *, char *);
5661d06d6bSBaptiste Daroussin int	 manconf_output(struct manoutput *, const char *, int);
5761d06d6bSBaptiste Daroussin void	 manconf_free(struct manconf *);
5861d06d6bSBaptiste Daroussin void	 manpath_base(struct manpaths *);
59