xref: /freebsd/usr.sbin/bsdconfig/USAGE (revision a03411e84728e9b267056fd31c7d1d9d1dc1b01e)
1# Copyright (c) 2012 Ron McDowell
2# Copyright (c) 2012-2013 Devin Teske
3# All rights reserved.
4#
5# Redistribution and use in source and binary forms, with or without
6# modification, are permitted provided that the following conditions
7# are met:
8# 1. Redistributions of source code must retain the above copyright
9#    notice, this list of conditions and the following disclaimer.
10# 2. Redistributions in binary form must reproduce the above copyright
11#    notice, this list of conditions and the following disclaimer in the
12#    documentation and/or other materials provided with the distribution.
13#
14# THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
15# ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17# ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
18# FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19# DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20# OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21# HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22# LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23# OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
24# SUCH DAMAGE.
25#
26
27Usage:
28	@PROGRAM_NAME@ [-h]
29	@PROGRAM_NAME@ command [-h]
30	@PROGRAM_NAME@ [OPTIONS] [command [OPTIONS]]
31
32OPTIONS:
33	-d         Provide lots of debugging info on standard-out when running.
34	-D file    Send debugging info to file. If file begins with a plus-sign
35	           debug info is sent to both standard-out and file (minus the
36	           leading plus).
37	-f file    Load file as script and then exit. If multiple occurrences,
38	           program will only exit after last occurrence. If file is a
39	           single dash (`-'), @PROGRAM_NAME@ reads from standard input.
40	-h         Print this usage statement and exit.
41	-S         Secure X11 mode (implies `-X'). As root, always prompt-for
42	           and validate sudo(8) username/password before starting.
43	-X         Use Xdialog(1) in place of dialog(1).
44
45COMMANDS:
46@COMMAND_LIST@
47