1# Copyright (c) 2013 Devin Teske 2# All rights reserved. 3# 4# Redistribution and use in source and binary forms, with or without 5# modification, are permitted provided that the following conditions 6# are met: 7# 1. Redistributions of source code must retain the above copyright 8# notice, this list of conditions and the following disclaimer. 9# 2. Redistributions in binary form must reproduce the above copyright 10# notice, this list of conditions and the following disclaimer in the 11# documentation and/or other materials provided with the distribution. 12# 13# THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 14# ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 15# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 16# ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 17# FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 18# DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 19# OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 20# HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 21# LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 22# OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 23# SUCH DAMAGE. 24# 25# $FreeBSD: releng/10.2/usr.sbin/bsdconfig/includes/USAGE 260675 2014-01-15 07:36:34Z dteske $ 26 27Usage: bsdconfig @PROGRAM_NAME@ [OPTIONS] [include ...] 28 29OPTIONS: 30 -a Always use color even when output is not to a terminal. 31 -d Print description for each function selected. Implies `-f'. 32 -f Show functions for selected includes. 33 -F pattern 34 If `-f', only print functions matching pattern. Without `-f' 35 print only includes containing functions matching pattern. 36 -h Print this usage statement and exit. 37 -n Disable the use of color. 38 39EXAMPLES: 40 View a list of available includes: 41 42 bsdconfig @PROGRAM_NAME@ 43 44 View functions for all available includes (function names are 45 highlighted): 46 47 bsdconfig @PROGRAM_NAME@ -f 48 49 View functions with less(1) (function names are not highlighted): 50 51 bsdconfig @PROGRAM_NAME@ -f | less 52 53 View functions with less(1) and color: 54 55 bsdconfig @PROGRAM_NAME@ -af | less -R 56 57 View functions from `common.subr': 58 59 bsdconfig @PROGRAM_NAME@ common.subr 60 61 NB: The `-f' flag is implied when given an include. 62 63 Show only functions containing the word `show' in common.subr: 64 65 bsdconfig @PROGRAM_NAME@ -F show common 66 67 NB: The `.subr' suffix on the end of the include is optional. 68 69 Show descriptions of each of the `show' functions: 70 71 bsdconfig @PROGRAM_NAME@ -dF show 72