Annotation of mandoc/mansearch.h, Revision 1.1
1.1 ! kristaps 1: /* $Id: manpath.h,v 1.5 2011/12/13 20:56:46 kristaps Exp $ */
! 2: /*
! 3: * Copyright (c) 2012 Kristaps Dzonsons <kristaps@bsd.lv>
! 4: *
! 5: * Permission to use, copy, modify, and distribute this software for any
! 6: * purpose with or without fee is hereby granted, provided that the above
! 7: * copyright notice and this permission notice appear in all copies.
! 8: *
! 9: * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
! 10: * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
! 11: * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
! 12: * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
! 13: * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
! 14: * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
! 15: * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
! 16: */
! 17: #ifndef MANSEARCH_H
! 18: #define MANSEARCH_H
! 19:
! 20: struct manpage {
! 21: char file[MAXPATHLEN]; /* prefixed by manpath */
! 22: char *desc; /* description of manpage */
! 23: int form; /* 0 == catpage */
! 24: };
! 25:
! 26: __BEGIN_DECLS
! 27:
! 28: int mansearch(const struct manpaths *paths, /* manpaths */
! 29: const char *arch, /* architecture */
! 30: const char *sec, /* manual section */
! 31: int argc, /* size of argv */
! 32: char *argv[], /* search terms */
! 33: struct manpage **res, /* results */
! 34: size_t *ressz); /* results returned */
! 35:
! 36: __END_DECLS
! 37:
! 38: #endif /*!MANSEARCH_H*/
CVSweb