# Copyright (c) 2012 Devin Teske
# All Rights Reserved.
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions
# are met:
# 1. Redistributions of source code must retain the above copyright
#    notice, this list of conditions and the following disclaimer.
# 2. Redistributions in binary form must reproduce the above copyright
#    notice, this list of conditions and the following disclaimer in the
#    documentation and/or other materials provided with the distribution.
#
# THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
# ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING BUT NOT LIMITED TO, THE
# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
# ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
# FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
# DAMAGES (INLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
# OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
# HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
# LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
# OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
# SUCH DAMAGE.
#
# $FreeBSD$

uSAGE: bsdconfig @PROGRAM_NAME@

options:
	-c    dON'T SHOW COMMAND-LINE SHORTCUT RELATIONSHIPS.
	-d    dON'T SHOW THE DATE IN THE GRAPH LABEL.
	-i    dON'T SHOW INCLUDE RELATIONSHIPS.

examples:
	vIEW dot(1) LANGUAGE OUTPUT DESCRIBING bsdconfig(8) LAYOUT/MAKE-UP:

		bsdconfig @PROGRAM_NAME@ | less

	rENDER dot(1) OUTPUT IN SVG FORMAT (DISPLAYS IN MOST MODERN BROWSERS):

		bsdconfig @PROGRAM_NAME@ | dot -Tsvg -o bsdconfig.svg

		note: rEQUIRES `graphics/graphviz' FROM PORTS/PACKAGES.

	vIEW THE ABOVE-RENDERED SVG FILE USING YOUR FAVORITE X11-BASED VIEWER:

		gimmage bsdconfig.svg

			note: rEQUIRES `graphics/gimmage' FROM PORTS/PACKAGES.

		OR

		gthumb bsdconfig.svg

			note: iMAGE INITIALLY SCALED TO FIT WINDOW ON LAUNCH.
			note: rEQUIRES `graphics/gthumb' FROM PORTS/PACKAGES.

		OR

		gqview bsdconfig.svg

			note: rEQUIRES `graphics/gqview' FROM PORTS/PACKAGES.

		OR

		gx bsdconfig.svg

			note: iMAGE INITIALLY SCALED TO FIT WINDOW ON LAUNCH.
			note: rEQUIRES `graphics/gx' FROM PORTS/PACKAGES.

		OR

		eog bsdconfig.svg

			note: rEQUIRES `graphics/eog' FROM PORTS/PACKAGES.

	rENDER dot(1) OUTPUT AS pOSTsCRIPT PRINT OUTPUT CONSISTING OF MULTIPLE
	us-lETTER SIZED PAGES THAT CAN BE ASSEMBLED INTO A LARGE POSTER (USING
	TRADITIONAL TOOLS SUCH AS SCISSORS AND TAPE):

		bsdconfig @PROGRAM_NAME@ | dot -Teps -o bsdconfig.eps
		poster -v -mLet -s1 -o bsdconfig.ps bsdconfig.eps

		note: cHANGE "-s1" ABOVE TO "-s0.5" TO HALVE THE SIZE OF THE
		      POSTER OR "-s2", FOR EXAMPLE, TO DOUBLE THE POSTER SIZE.

		note: rEQUIRES BOTH `graphics/graphviz' AND `print/poster' FROM
		      PORTS/PACKAGES.

	rENDER dot(1) OUTPUT AS pOSTsCRIPT SCALED TO FIT ON A POSTER CONSISTING
	OF 2X-WIDE AND 4X-TALL us-lETTER SIZED PAGES:

		bsdconfig @PROGRAM_NAME@ | dot -Teps -o bsdconfig.eps
		poster -v -mLet -p2x4Letter -o bsdconfig.ps bsdconfig.eps

		note: rEQUIRES BOTH `graphics/graphviz' AND `print/poster' FROM
		      PORTS/PACKAGES.

	vIEW THE ABOVE-RENDERED pOSTsCRIPT POSTER USING X11:

		gsview bsdconfig.ps

			note: rEQUIRES `print/gsview' FROM PORTS/PACKAGES.

		OR

		convert bsdconfig.ps bsdconfig.pdf
		xpdf bsdconfig.pdf

			note: rEQUIRES BOTH `graphics/ImageMagick' AND
			      `graphics/xdpf' FROM PORTS/PACKAGES.

			note: tHE CONVERTED PDF FILE IS NOT SUITABLE FOR
			      PRINTING DUE TO LOSS OF QUALITY DURING THE
			      CONVERSION PROCESS.

	pRINT THE ABOVE-RENDERED pOSTsCRIPT POSTER:

		lpr -h bsdconfig.ps

		note: rEQUIRES CONFIGURATION OF A PRINTER IN `/etc/printcap'.

	eXTRACT EACH PAGE OF THE POSTER INTO A SEPARATE PNG FILE:

		gs -q -dNOPAUSE -dBATCH -sPAPERSIZE=letter \
		   -dTextAlphaBits=4 -dGraphicsAlphaBits=4 \
		   -sDEVICE=png16m -sOutputFile=bsdconfig%03d.png \
		   bsdconfig.ps

		note: rEQUIRES `print/ghostscript9' FROM PORTS/PACKAGES.

		note: tHE CONVERTED PNG FILES ARE NOT SUITABLE FOR PRINTING
		      DUE TO LOSS OF QUALITY DURING THE CONVERSION PROCESS.

	eXTRACT A SINGLE PAGE OF THE POSTER INTO A SEPARATE pOSTsCRIPT FILE FOR
	PRINTING INDIVIDUAL PAGES FROM THE COMMAND-LINE:

		psselect 1 bsdconfig.ps bsdconfig-page1.ps
		lpr -h bsdconfig-page1.ps

		note: cHANGE "1" TO "2" FOR THE SECOND PAGE, AD-INFINITUM.
		note: rEQUIRES `print/psutils-letter' FROM PORTS/PACKAGES.
