usr.sbin/bsdconfig/dot/USAGE

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