Revision: 55549
http://sourceforge.net/p/brlcad/code/55549
Author: brlcad
Date: 2013-05-23 04:16:14 +0000 (Thu, 23 May 2013)
Log Message:
-----------
indent and format to look for tag errors, but looks clean
Modified Paths:
--------------
brlcad/trunk/doc/docbook/system/man1/en/fb-rle.xml
Modified: brlcad/trunk/doc/docbook/system/man1/en/fb-rle.xml
===================================================================
--- brlcad/trunk/doc/docbook/system/man1/en/fb-rle.xml 2013-05-23 04:03:45 UTC
(rev 55548)
+++ brlcad/trunk/doc/docbook/system/man1/en/fb-rle.xml 2013-05-23 04:16:14 UTC
(rev 55549)
@@ -1,210 +1,210 @@
<?xml version="1.0" encoding="ISO-8859-1"?>
<refentry xmlns='http://docbook.org/ns/docbook' version='5.0' xml:lang='en'
xml:id="fbrle1">
-<refmeta>
- <refentrytitle>FB-RLE
-</refentrytitle>
-<manvolnum>1</manvolnum>
-<refmiscinfo class="source">BRL-CAD</refmiscinfo>
-<refmiscinfo class="manual">BRL-CAD</refmiscinfo>
-</refmeta>
+ <refmeta>
+ <refentrytitle>FB-RLE</refentrytitle>
+ <manvolnum>1</manvolnum>
+ <refmiscinfo class="source">BRL-CAD</refmiscinfo>
+ <refmiscinfo class="manual">BRL-CAD</refmiscinfo>
+ </refmeta>
-<refnamediv>
-<refname>fb-rle</refname>
-<refpurpose>save frame buffer image in a run-length encoded file</refpurpose>
-</refnamediv>
-<!-- body begins here -->
-<refsynopsisdiv xml:id="synopsis">
-<cmdsynopsis sepchar=" ">
- <command>fb-rle</command>
- <arg choice="opt" rep="norepeat">-cd </arg>
- <arg choice="opt" rep="norepeat">-F
<replaceable>framebuffer</replaceable></arg>
- <arg choice="opt" rep="norepeat">-C <replaceable>r/g/b</replaceable></arg>
- <arg choice="opt" rep="norepeat">-S
<replaceable>squarescrsize</replaceable></arg>
- <arg choice="opt" rep="norepeat">-W
<replaceable>scr_width</replaceable></arg>
- <arg choice="opt" rep="norepeat">-N
<replaceable>scr_height</replaceable></arg>
- <arg choice="opt" rep="norepeat">-X
<replaceable>scr_xoff</replaceable></arg>
- <arg choice="opt" rep="norepeat">-Y
<replaceable>scr_yoff</replaceable></arg>
- <arg choice="opt" rep="norepeat">-s
<replaceable>squarefilesize</replaceable></arg>
- <arg choice="opt" rep="norepeat">-w
<replaceable>file_width</replaceable></arg>
- <arg choice="opt" rep="norepeat">-n
<replaceable>file_height</replaceable></arg>
- <arg choice="opt" rep="norepeat"><replaceable>file.rle</replaceable></arg>
-</cmdsynopsis>
-</refsynopsisdiv>
+ <refnamediv>
+ <refname>fb-rle</refname>
+ <refpurpose>save frame buffer image in a run-length encoded
file</refpurpose>
+ </refnamediv>
+ <!-- body begins here -->
+ <refsynopsisdiv xml:id="synopsis">
+ <cmdsynopsis sepchar=" ">
+ <command>fb-rle</command>
+ <arg choice="opt" rep="norepeat">-cd </arg>
+ <arg choice="opt" rep="norepeat">-F
<replaceable>framebuffer</replaceable></arg>
+ <arg choice="opt" rep="norepeat">-C
<replaceable>r/g/b</replaceable></arg>
+ <arg choice="opt" rep="norepeat">-S
<replaceable>squarescrsize</replaceable></arg>
+ <arg choice="opt" rep="norepeat">-W
<replaceable>scr_width</replaceable></arg>
+ <arg choice="opt" rep="norepeat">-N
<replaceable>scr_height</replaceable></arg>
+ <arg choice="opt" rep="norepeat">-X
<replaceable>scr_xoff</replaceable></arg>
+ <arg choice="opt" rep="norepeat">-Y
<replaceable>scr_yoff</replaceable></arg>
+ <arg choice="opt" rep="norepeat">-s
<replaceable>squarefilesize</replaceable></arg>
+ <arg choice="opt" rep="norepeat">-w
<replaceable>file_width</replaceable></arg>
+ <arg choice="opt" rep="norepeat">-n
<replaceable>file_height</replaceable></arg>
+ <arg choice="opt"
rep="norepeat"><replaceable>file.rle</replaceable></arg>
+ </cmdsynopsis>
+ </refsynopsisdiv>
-<refsection xml:id="description"><title>DESCRIPTION</title>
-<para><emphasis remap="I">fb-rle</emphasis>
-saves an image from a frame buffer in the University of Utah
-standard (Edition-3, or "Utah Raster Toolkit")
-Run-Length Encoded (RLE) format file
-(these files can be displayed with
-<citerefentry><refentrytitle>rle-fb</refentrytitle><manvolnum>1</manvolnum></citerefentry>
-or a similar program).
-If
-<emphasis remap="I">file.rle</emphasis>
-is not specified, standard output is written.</para>
+ <refsection xml:id="description"><title>DESCRIPTION</title>
+ <para><emphasis remap="I">fb-rle</emphasis> saves an image from a
+ frame buffer in the University of Utah standard (Edition-3, or
+ "Utah Raster Toolkit") Run-Length Encoded (RLE) format file
+ (these files can be displayed with
+
<citerefentry><refentrytitle>rle-fb</refentrytitle><manvolnum>1</manvolnum></citerefentry>
+ or a similar program). If
+ <emphasis remap="I">file.rle</emphasis> is not specified,
+ standard output is written.</para>
-<para>The size of the image to be saved can be set with the
-<option>-s</option>
-or
-<option>-n</option>
-and
-<option>-w</option>
-command line options. If these are omitted, the entire
-screen area will be saved.
-The image rectangle to be saved
-can be repositioned on the screen with the
-<option>-X</option>
-and
-<option>-Y</option>
-command line options.</para>
-<variablelist remap="TP">
- <varlistentry>
- <term><option>-W</option> <replaceable>scr_width</replaceable></term>
- <listitem>
-<para>specifies the desired width of the screen, in pixels.</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-N</option> <replaceable>scr_height</replaceable></term>
- <listitem>
-<para>specifies the desired height of the screen, in scanlines.</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-S</option> <replaceable>squarescrsize</replaceable></term>
- <listitem>
-<para>sets the screen width and height to the indicated value.</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-F</option> <replaceable>framebuffer</replaceable></term>
- <listitem>
-<para>This option specifies which framebuffer the image is to be saved from.
-If not given, the environment variable
-<acronym/><emphasis remap="B">FB_FILE</emphasis>
-is used to select the display device (see
-<emphasis remap="I">brlcad(1)</emphasis>).
-If
-<acronym/><emphasis remap="B">FB_FILE</emphasis>
-has not been set, the default device for your system will
-be used.</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-w</option> <replaceable>file_width</replaceable></term>
- <listitem>
-<para>specifies the desired width of the saved image, in pixels.</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-n</option> <replaceable>file_height</replaceable></term>
- <listitem>
-<para>specifies the desired height of the saved image, in scanlines.</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-s</option> <replaceable>squarefilesize</replaceable></term>
- <listitem>
-<para>sets the saved image width and height to the indicated value.</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-c</option></term>
- <listitem>
-<para>The "crunch colormap" option.
-If the frame buffer contains a non standard (i.e. non linear) colormap,
-rather than saving that colormap in the RLE file
-this option causes the colormap to be applied
-to the pixel data before it is saved in the file.
-This can be useful to preserve dramatic images created with weird color maps
-such that Gamma correction (e.g., for film) can also be applied.
-This option is recommended when producing images for export to other
-display systems, so that variations in the interpretation of color maps
-between different types of display hardware do
-not affect the displayed image.</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-d</option></term>
- <listitem>
-<para>Debug option, provides a verbose description of the input file structure
and
-image decoding process, written on standard error.</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-C</option> <replaceable>r/g/b</replaceable></term>
- <listitem>
-<para>The background value to be recorded in the RLE file is normally
-automatically selected from the display.
-This option permits
-the user to specify an alternate background color
-as a red/green/blue triple, separated by slashes ("/").
-The color intensity in each channel ranges from 0 (dark) to 255
(bright).</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-X</option> <replaceable>scr_xoff</replaceable></term>
- <listitem>
-<para>Specify a screen X offset, which will offset the saved area onto the
screen
-by the given amount. (i.e.,
-<option>-X</option> <literal>10</literal>
-would place (0,10) on the screen in the RLE image rectangle coordinate
(0,0).</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-Y</option> <replaceable>scr_yoff</replaceable></term>
- <listitem>
-<para>Specify a screen Y offset, which will offset the saved area onto the
screen
-by the given amount.</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis remap="I">file.rle</emphasis></term>
- <listitem>
-<para>Name of file to be written, in RLE format.
-If not specified, standard output is used instead.</para>
- </listitem>
- </varlistentry>
-</variablelist>
+ <para>The size of the image to be saved can be set with the
+ <option>-s</option>
+ or
+ <option>-n</option>
+ and
+ <option>-w</option> command line options. If these are omitted,
+ the entire screen area will be saved. The image rectangle to be
+ saved can be repositioned on the screen with the
+ <option>-X</option> and
+ <option>-Y</option> command line options.</para>
+ <variablelist remap="TP">
+ <varlistentry>
+ <term><option>-W</option> <replaceable>scr_width</replaceable></term>
+ <listitem>
+ <para>specifies the desired width of the screen, in
+ pixels.</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><option>-N</option> <replaceable>scr_height</replaceable></term>
+ <listitem>
+ <para>specifies the desired height of the screen, in
+ scanlines.</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><option>-S</option>
<replaceable>squarescrsize</replaceable></term>
+ <listitem>
+ <para>sets the screen width and height to the indicated
+ value.</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><option>-F</option> <replaceable>framebuffer</replaceable></term>
+ <listitem>
+ <para>This option specifies which framebuffer the image is
+ to be saved from. If not given, the environment variable
+ <acronym/><emphasis remap="B">FB_FILE</emphasis> is used
+ to select the display device (see
+ <emphasis remap="I">brlcad(1)</emphasis>). If
+ <acronym/><emphasis remap="B">FB_FILE</emphasis> has not
+ been set, the default device for your system will be
+ used.</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><option>-w</option> <replaceable>file_width</replaceable></term>
+ <listitem>
+ <para>specifies the desired width of the saved image, in
+ pixels.</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><option>-n</option> <replaceable>file_height</replaceable></term>
+ <listitem>
+ <para>specifies the desired height of the saved image, in
+ scanlines.</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><option>-s</option>
<replaceable>squarefilesize</replaceable></term>
+ <listitem>
+ <para>sets the saved image width and height to the indicated
+ value.</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><option>-c</option></term>
+ <listitem>
+ <para>The "crunch colormap" option. If the frame buffer
+ contains a non standard (i.e. non linear) colormap, rather
+ than saving that colormap in the RLE file this option
+ causes the colormap to be applied to the pixel data before
+ it is saved in the file. This can be useful to preserve
+ dramatic images created with weird color maps such that
+ Gamma correction (e.g., for film) can also be applied.
+ This option is recommended when producing images for
+ export to other display systems, so that variations in the
+ interpretation of color maps between different types of
+ display hardware do not affect the displayed image.</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><option>-d</option></term>
+ <listitem>
+ <para>Debug option, provides a verbose description of the
+ input file structure and image decoding process, written
+ on standard error.</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><option>-C</option> <replaceable>r/g/b</replaceable></term>
+ <listitem>
+ <para>The background value to be recorded in the RLE file is
+ normally automatically selected from the display. This
+ option permits the user to specify an alternate background
+ color as a red/green/blue triple, separated by slashes
+ ("/"). The color intensity in each channel ranges from 0
+ (dark) to 255 (bright).</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><option>-X</option> <replaceable>scr_xoff</replaceable></term>
+ <listitem>
+ <para>Specify a screen X offset, which will offset the saved
+ area onto the screen by the given amount. (i.e.,
+ <option>-X</option> <literal>10</literal> would place (0,
+ 10) on the screen in the RLE image rectangle coordinate
+ (0, 0).</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><option>-Y</option> <replaceable>scr_yoff</replaceable></term>
+ <listitem>
+ <para>Specify a screen Y offset, which will offset the saved
+ area onto the screen by the given amount.</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><emphasis remap="I">file.rle</emphasis></term>
+ <listitem>
+ <para>Name of file to be written, in RLE format. If not
+ specified, standard output is used instead.</para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
-<para>The run length encoded image format is best used for the long-term
-storage of images, as it uses less disk storage than a
-<emphasis remap="I">pix(5)</emphasis>
-file, at the expense of requiring more processing
-for the encoding and decoding.
-This program is also useful when using the Utah Raster Toolkit
-utilities, which only operate on RLE encoded files.</para>
-</refsection>
+ <para>The run length encoded image format is best used for the
+ long-term storage of images, as it uses less disk storage than a
+ <emphasis remap="I">pix(5)</emphasis> file, at the expense of
+ requiring more processing for the encoding and decoding. This
+ program is also useful when using the Utah Raster Toolkit
+ utilities, which only operate on RLE encoded files.</para>
+ </refsection>
-<refsection xml:id="examples"><title>EXAMPLES</title>
- <blockquote remap="RS">
-<para>fb-rle truck.rle
-<!-- .br -->
-fb-rle -C 0/255/0 >car.rle
-<!-- .br -->
-fb-rle -h -s 512 >lowerleft.rle
- </para></blockquote> <!-- remap='RE' -->
-</refsection>
+ <refsection xml:id="examples"><title>EXAMPLES</title>
+ <blockquote remap="RS">
+ <para>fb-rle truck.rle
+ <!-- .br -->
+ fb-rle -C 0/255/0 >car.rle
+ <!-- .br -->
+ fb-rle -h -s 512 >lowerleft.rle
+ </para></blockquote> <!-- remap='RE' -->
+ </refsection>
-<refsection xml:id="see_also"><title>SEE ALSO</title>
-<para><citerefentry><refentrytitle>brlcad</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
<citerefentry><refentrytitle>rle-fb</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
<citerefentry><refentrytitle>fb-pix</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
<citerefentry><refentrytitle>rle-pix</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
<citerefentry><refentrytitle>pix-rle</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
-<citerefentry><refentrytitle>pixrect</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
<citerefentry><refentrytitle>pixscale</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
<citerefentry><refentrytitle>pixmerge</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
-<citerefentry><refentrytitle>comp</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
<citerefentry><refentrytitle>crop</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
<citerefentry><refentrytitle>repos</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
<citerefentry><refentrytitle>rlepatch</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
<citerefentry><refentrytitle>rlebox</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
-<citerefentry><refentrytitle>librle</refentrytitle><manvolnum>3</manvolnum></citerefentry>.</para>
-</refsection>
+ <refsection xml:id="see_also"><title>SEE ALSO</title>
+
<para><citerefentry><refentrytitle>brlcad</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
<citerefentry><refentrytitle>rle-fb</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
<citerefentry><refentrytitle>fb-pix</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
<citerefentry><refentrytitle>rle-pix</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
<citerefentry><refentrytitle>pix-rle</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
+
<citerefentry><refentrytitle>pixrect</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
<citerefentry><refentrytitle>pixscale</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
<citerefentry><refentrytitle>pixmerge</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
+
<citerefentry><refentrytitle>comp</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
<citerefentry><refentrytitle>crop</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
<citerefentry><refentrytitle>repos</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
<citerefentry><refentrytitle>rlepatch</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
<citerefentry><refentrytitle>rlebox</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
+
<citerefentry><refentrytitle>librle</refentrytitle><manvolnum>3</manvolnum></citerefentry>.</para>
+ </refsection>
-<refsection xml:id="author"><title>AUTHOR</title>
-<para>BRL-CAD Team</para>
-</refsection>
+ <refsection xml:id="author"><title>AUTHOR</title>
+ <para>BRL-CAD Team</para>
+ </refsection>
-<refsection xml:id="copyright"><title>COPYRIGHT</title>
-<para>This software is Copyright (c) 1988-2013 by the United States
-Government as represented by U.S. Army Research Laboratory.</para>
-</refsection>
+ <refsection xml:id="copyright"><title>COPYRIGHT</title>
+ <para>This software is Copyright (c) 1988-2013 by the United
+ States Government as represented by U.S. Army Research
+ Laboratory.</para>
+ </refsection>
-<refsection xml:id="bug_reports"><title>BUG REPORTS</title>
-<para>Reports of bugs or problems should be submitted via electronic
-mail to <[email protected]>.</para>
-</refsection>
+ <refsection xml:id="bug_reports"><title>BUG REPORTS</title>
+ <para>Reports of bugs or problems should be submitted via
+ electronic mail to <[email protected]>.</para>
+ </refsection>
</refentry>
This was sent by the SourceForge.net collaborative development platform, the
world's largest Open Source development site.
------------------------------------------------------------------------------
Try New Relic Now & We'll Send You this Cool Shirt
New Relic is the only SaaS-based application performance monitoring service
that delivers powerful full stack analytics. Optimize and monitor your
browser, app, & servers with just a few lines of code. Try New Relic
and get this awesome Nerd Life shirt! http://p.sf.net/sfu/newrelic_d2d_may
_______________________________________________
BRL-CAD Source Commits mailing list
[email protected]
https://lists.sourceforge.net/lists/listinfo/brlcad-commits
