/contrib/groff/contrib/grap2graph/grap2graph.man

https://bitbucket.org/freebsd/freebsd-head/ · Unknown · 105 lines · 105 code · 0 blank · 0 comment · 0 complexity · 0dd048dbbc38523f0314da997d23597f MD5 · raw file 

    

  1. .\" $Id: grap2graph.man,v 1.3 2003/10/28 07:46:23 wlemb Exp $
    2. 

  2. .\" This documentation is released to the public domain.
    3. 

  3. .
    4. 

  4. .
    5. 

  5. .TH GRAP2GRAPH @MAN1EXT@ "@MDATE@" "Groff Version @VERSION@"
    6. 

  6. .IX grap2graph
    7. 

  7. .SH NAME
    8. 

  8. grap2graph \- convert a grap diagram into a cropped bitmap image
    9. 

  9. .
    10. 

  10. .
    11. 

  11. .SH SYNOPSIS
    12. 

  12. .B grap2graph
    13. 

  13. [
    14. 

  14. .B \-unsafe
    15. 

  15. ]
    16. 

  16. [
    17. 

  17. .BI \-resolution\  M\fR|\fPMxN
    18. 

  18. ]
    19. 

  19. [
    20. 

  20. .BI \-format\  fmt
    21. 

  21. ]
    22. 

  22. .
    23. 

  23. .
    24. 

  24. .SH DESCRIPTION
    25. 

  25. Reads a grap program as input; produces an image file (by default in
    26. 

  26. Portable Network Graphics format) suitable for the Web as output.
    27. 

  27. For a description of the grap language, see
    28. 

  28. .BR grap (1).
    29. 

  29. .P
    30. 

  30. Your graph specification should \fInot\fR be wrapped with the \&.G1 and
    31. 

  31. \&.G2 macros that normally guard it within
    32. 

  32. .BR groff (@MAN1EXT@)
    33. 

  33. macros.
    34. 

  34. .P
    35. 

  35. The output image will be a black-on-white graphic clipped to the
    36. 

  36. smallest possible bounding box that contains all the black pixels.
    37. 

  37. By specifying command-line options to be passed to 
    38. 

  38. .BR convert (1)
    39. 

  39. you can give it a border, set the background transparent, set the
    40. 

  40. image's pixel density, or perform other useful transformations.
    41. 

  41. .P
    42. 

  42. This program uses 
    43. 

  43. .BR grap (1),
    44. 

  44. .BR @g@pic (@MAN1EXT@),
    45. 

  45. .BR groff (@MAN1EXT@),
    46. 

  46. and the ImageMagick 
    47. 

  47. .BR convert (1)
    48. 

  48. program.
    49. 

  49. These programs must be installed on your system and accessible on your
    50. 

  50. $PATH for \fBgrap2graph\fR to work.
    51. 

  51. .
    52. 

  52. .
    53. 

  53. .SH OPTIONS
    54. 

  54. .TP
    55. 

  55. .B \-unsafe
    56. 

  56. Run 
    57. 

  57. .BR @g@pic (@MAN1EXT@)
    58. 

  58. and
    59. 

  59. .BR groff (@MAN1EXT@)
    60. 

  60. in the `unsafe' mode enabling the PIC macro
    61. 

  61. .B sh
    62. 

  62. to execute arbitrary commands.
    63. 

  63. The default is to forbid this.
    64. 

  64. .TP
    65. 

  65. .BI \-format\  fmt
    66. 

  66. Specify an output format; the default is PNG (Portable Network Graphics).
    67. 

  67. Any format that
    68. 

  68. .BR convert (1)
    69. 

  69. can emit is supported.
    70. 

  70. .PP
    71. 

  71. Command-line switches and arguments not listed above are passed to
    72. 

  72. .BR convert (1).
    73. 

  73. .
    74. 

  74. .
    75. 

  75. .SH ENVIRONMENT
    76. 

  76. .TP
    77. 

  77. .B GROFF_TMPDIR
    78. 

  78. The directory in which temporary files will be created.
    79. 

  79. If this is not set
    80. 

  80. .B grap2graph
    81. 

  81. searches the environment variables
    82. 

  82. .BR \%TMPDIR ,
    83. 

  83. .BR TMP ,
    84. 

  84. and
    85. 

  85. .B TEMP
    86. 

  86. (in that order).
    87. 

  87. Otherwise, temporary files will be created in
    88. 

  88. .BR /tmp .
    89. 

  89. .
    90. 

  90. .
    91. 

  91. .SH "SEE ALSO"
    92. 

  92. .BR pic2graph (@MAN1EXT@),
    93. 

  93. .BR eqn2graph (@MAN1EXT@),
    94. 

  94. .BR @g@pic (@MAN1EXT@),
    95. 

  95. .BR groff (@MAN1EXT@),
    96. 

  96. .BR gs (1),
    97. 

  97. .BR convert (1).
    98. 

  98. .
    99. 

  99. .
    100. 

  100. .SH AUTHOR
    101. 

  101. Eric S. Raymond <esr@thyrsus.com>
    102. 

  102. .
    103. 

  103. .\" Local Variables:
    104. 

  104. .\" mode: nroff
    105. 

  105. .\" End:
    106.