xref: /freebsd/usr.sbin/bsdconfig/dot/USAGE (revision 00c8e7691001f5659f2bd2dbadb31fe48d9f61c7)
1# Copyright (c) 2012-2026 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
26Usage: bsdconfig @PROGRAM_NAME@ [OPTIONS]
27
28OPTIONS:
29	-h    Print this usage statement and exit.
30	-c    Don't show command-line shortcut relationships.
31	-d    Don't show the date in the graph label.
32	-i    Don't show include relationships.
33
34EXAMPLES:
35	View dot(1) language output describing bsdconfig(8) layout/make-up:
36
37		bsdconfig @PROGRAM_NAME@ | less
38
39	Render dot(1) output in SVG format (displays in most modern browsers):
40
41		bsdconfig @PROGRAM_NAME@ | dot -Tsvg -o bsdconfig.svg
42
43		NOTE: Requires `graphics/graphviz' from ports/packages.
44
45	View the above-rendered SVG file using your favorite X11-based viewer:
46
47		gthumb bsdconfig.svg
48
49			NOTE: Image is scaled to fit window on launch.
50			NOTE: Requires `graphics/gthumb' from ports/packages.
51
52		or
53
54		eog bsdconfig.svg
55
56			NOTE: Requires `graphics/eog' from ports/packages.
57
58	Render dot(1) output as PostScript print output consisting of multiple
59	US-Letter sized pages that can be assembled into a large poster (using
60	traditional tools such as scissors and tape):
61
62		bsdconfig @PROGRAM_NAME@ | dot -Teps -o bsdconfig.eps
63		poster -v -mLet -s1 -o bsdconfig.ps bsdconfig.eps
64
65		NOTE: Change "-s1" above to "-s0.5" to halve the size of the
66		      poster or "-s2", for example, to double the poster size.
67
68		NOTE: Requires both `graphics/graphviz' and `print/poster' from
69		      ports/packages.
70
71	Render dot(1) output as PostScript scaled to fit on a poster consisting
72	of 2x-wide and 4x-tall US-Letter sized pages:
73
74		bsdconfig @PROGRAM_NAME@ | dot -Teps -o bsdconfig.eps
75		poster -v -mLet -p2x4Letter -o bsdconfig.ps bsdconfig.eps
76
77		NOTE: Requires both `graphics/graphviz' and `print/poster' from
78		      ports/packages.
79
80	View the above-rendered PostScript poster using X11:
81
82		gm convert bsdconfig.ps bsdconfig.pdf
83		xpdf bsdconfig.pdf
84
85			NOTE: Requires both `graphics/GraphicsMagick' and
86			      `graphics/xdpf' from ports/packages.
87
88			NOTE: The converted PDF file is not suitable for
89			      printing due to loss of quality during the
90			      conversion process.
91
92	Print the above-rendered PostScript poster:
93
94		lpr -h bsdconfig.ps
95
96		NOTE: Requires configuration of a printer in `/etc/printcap'.
97
98	Extract each page of the poster into a separate PNG file:
99
100		gs -q -dNOPAUSE -dBATCH -sPAPERSIZE=letter \
101		   -dTextAlphaBits=4 -dGraphicsAlphaBits=4 \
102		   -sDEVICE=png16m -sOutputFile=bsdconfig%03d.png \
103		   bsdconfig.ps
104
105		NOTE: Requires `print/ghostscript9' from ports/packages.
106
107		NOTE: The converted PNG files are not suitable for printing
108		      due to loss of quality during the conversion process.
109
110	Extract a single page of the poster into a separate PostScript file for
111	printing individual pages from the command-line:
112
113		psselect 1 bsdconfig.ps bsdconfig-page1.ps
114		lpr -h bsdconfig-page1.ps
115
116		NOTE: Change "1" to "2" for the second page, ad-infinitum.
117		NOTE: Requires `print/psutils-letter' from ports/packages.
118