1258400Sdteske# Copyright (c) 2013 Devin Teske
2258400Sdteske# All rights reserved.
3258400Sdteske#
4258400Sdteske# Redistribution and use in source and binary forms, with or without
5258400Sdteske# modification, are permitted provided that the following conditions
6258400Sdteske# are met:
7258400Sdteske# 1. Redistributions of source code must retain the above copyright
8258400Sdteske#    notice, this list of conditions and the following disclaimer.
9258400Sdteske# 2. Redistributions in binary form must reproduce the above copyright
10258400Sdteske#    notice, this list of conditions and the following disclaimer in the
11258400Sdteske#    documentation and/or other materials provided with the distribution.
12258400Sdteske#
13258400Sdteske# THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
14258400Sdteske# ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15258400Sdteske# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
16258400Sdteske# ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
17258400Sdteske# FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
18258400Sdteske# DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
19258400Sdteske# OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
20258400Sdteske# HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
21258400Sdteske# LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
22258400Sdteske# OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
23258400Sdteske# SUCH DAMAGE.
24258400Sdteske#
25258400Sdteske# $FreeBSD$
26258400Sdteske
27258400SdteskeUsage: bsdconfig @PROGRAM_NAME@ [OPTIONS] [include ...]
28258400Sdteske
29258400SdteskeOPTIONS:
30258400Sdteske	-a    Always use color even when output is not to a terminal.
31260675Sdteske	-d    Print description for each function selected. Implies `-f'.
32258400Sdteske	-f    Show functions for selected includes.
33258400Sdteske	-F pattern
34258400Sdteske	      If `-f', only print functions matching pattern. Without `-f'
35258400Sdteske	      print only includes containing functions matching pattern.
36258400Sdteske	-h    Print this usage statement and exit.
37258400Sdteske	-n    Disable the use of color.
38258400Sdteske
39258400SdteskeEXAMPLES:
40258400Sdteske	View a list of available includes:
41258400Sdteske
42258400Sdteske		bsdconfig @PROGRAM_NAME@
43258400Sdteske
44258400Sdteske	View functions for all available includes (function names are
45258400Sdteske	highlighted):
46258400Sdteske
47258400Sdteske		bsdconfig @PROGRAM_NAME@ -f
48258400Sdteske
49258400Sdteske	View functions with less(1) (function names are not highlighted):
50258400Sdteske
51258400Sdteske		bsdconfig @PROGRAM_NAME@ -f | less
52258400Sdteske
53258400Sdteske	View functions with less(1) and color:
54258400Sdteske
55258400Sdteske		bsdconfig @PROGRAM_NAME@ -af | less -R
56258400Sdteske
57258400Sdteske	View functions from `common.subr':
58258400Sdteske
59258400Sdteske		bsdconfig @PROGRAM_NAME@ common.subr
60258400Sdteske
61258400Sdteske	NB: The `-f' flag is implied when given an include.
62258400Sdteske
63258400Sdteske	Show only functions containing the word `show' in common.subr:
64258400Sdteske
65258400Sdteske		bsdconfig @PROGRAM_NAME@ -F show common
66258400Sdteske
67258400Sdteske	NB: The `.subr' suffix on the end of the include is optional.
68260675Sdteske
69260675Sdteske	Show descriptions of each of the `show' functions:
70260675Sdteske
71260675Sdteske		bsdconfig @PROGRAM_NAME@ -dF show
72