xref: /freebsd/usr.sbin/bsdconfig/dot/USAGE (revision 2008043f386721d58158e37e0d7e50df8095942d)
1# Copyright (c) 2012-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
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		gimmage bsdconfig.svg
48
49			NOTE: Requires `graphics/gimmage' from ports/packages.
50
51		or
52
53		gthumb bsdconfig.svg
54
55			NOTE: Image is scaled to fit window on launch.
56			NOTE: Requires `graphics/gthumb' from ports/packages.
57
58		or
59
60		gqview bsdconfig.svg
61
62			NOTE: Requires `graphics/gqview' from ports/packages.
63
64		or
65
66		gx bsdconfig.svg
67
68			NOTE: Image is scaled to fit window on launch.
69			NOTE: Requires `graphics/gx' from ports/packages.
70
71		or
72
73		eog bsdconfig.svg
74
75			NOTE: Requires `graphics/eog' from ports/packages.
76
77	Render dot(1) output as PostScript print output consisting of multiple
78	US-Letter sized pages that can be assembled into a large poster (using
79	traditional tools such as scissors and tape):
80
81		bsdconfig @PROGRAM_NAME@ | dot -Teps -o bsdconfig.eps
82		poster -v -mLet -s1 -o bsdconfig.ps bsdconfig.eps
83
84		NOTE: Change "-s1" above to "-s0.5" to halve the size of the
85		      poster or "-s2", for example, to double the poster size.
86
87		NOTE: Requires both `graphics/graphviz' and `print/poster' from
88		      ports/packages.
89
90	Render dot(1) output as PostScript scaled to fit on a poster consisting
91	of 2x-wide and 4x-tall US-Letter sized pages:
92
93		bsdconfig @PROGRAM_NAME@ | dot -Teps -o bsdconfig.eps
94		poster -v -mLet -p2x4Letter -o bsdconfig.ps bsdconfig.eps
95
96		NOTE: Requires both `graphics/graphviz' and `print/poster' from
97		      ports/packages.
98
99	View the above-rendered PostScript poster using X11:
100
101		gsview bsdconfig.ps
102
103			NOTE: Requires `print/gsview' from ports/packages.
104
105		or
106
107		convert bsdconfig.ps bsdconfig.pdf
108		xpdf bsdconfig.pdf
109
110			NOTE: Requires both `graphics/ImageMagick' and
111			      `graphics/xdpf' from ports/packages.
112
113			NOTE: The converted PDF file is not suitable for
114			      printing due to loss of quality during the
115			      conversion process.
116
117	Print the above-rendered PostScript poster:
118
119		lpr -h bsdconfig.ps
120
121		NOTE: Requires configuration of a printer in `/etc/printcap'.
122
123	Extract each page of the poster into a separate PNG file:
124
125		gs -q -dNOPAUSE -dBATCH -sPAPERSIZE=letter \
126		   -dTextAlphaBits=4 -dGraphicsAlphaBits=4 \
127		   -sDEVICE=png16m -sOutputFile=bsdconfig%03d.png \
128		   bsdconfig.ps
129
130		NOTE: Requires `print/ghostscript9' from ports/packages.
131
132		NOTE: The converted PNG files are not suitable for printing
133		      due to loss of quality during the conversion process.
134
135	Extract a single page of the poster into a separate PostScript file for
136	printing individual pages from the command-line:
137
138		psselect 1 bsdconfig.ps bsdconfig-page1.ps
139		lpr -h bsdconfig-page1.ps
140
141		NOTE: Change "1" to "2" for the second page, ad-infinitum.
142		NOTE: Requires `print/psutils-letter' from ports/packages.
143