home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: 11 Util / 11-Util.zip / xloadimg.zip / xloadimage.4.1 / xloadimage.txt < prev    next >
Text File  |  1993-11-09  |  34KB  |  925 lines

  1.  
  2.  
  3.  
  4. XLOADIMAGE(1)            USER COMMANDS              XLOADIMAGE(1)
  5.  
  6.  
  7.  
  8. NAME
  9.      xloadimage, xsetbg, xview - load images into an  X11  window
  10.      or onto the root window
  11.  
  12. SYNOPSIS
  13.      _x_l_o_a_d_i_m_a_g_e [global_options] {[image_options] image ...}
  14.      _x_l_o_a_d_i_m_a_g_e [global_options] [image_options] stdin < image
  15.  
  16. DESCRIPTION
  17.      _X_l_o_a_d_i_m_a_g_e displays images in an X11 window, loads them onto
  18.      the  root  window,  or  writes them into a file.  Many image
  19.      types are recognized; use  the  -_s_u_p_p_o_r_t_e_d  option  to  list
  20.      them.
  21.  
  22.      If the filename _s_t_d_i_n is given,  xloadimage  will  read  the
  23.      image from standard input if this capability is supported by
  24.      the loader for that image type (most types do support  read-
  25.      ing from stdin).
  26.  
  27.      If the destination display  cannot  support  the  number  of
  28.      colors  in the image, the image will be dithered (monochrome
  29.      destination) or have its colormap  reduced  (color  destina-
  30.      tion)  as  appropriate.  This can also be done forcibly with
  31.      the -_h_a_l_f_t_o_n_e, -_d_i_t_h_e_r, and -_c_o_l_o_r_s options.
  32.  
  33.      A variety of image manipulations can be specified, including
  34.      gamma  correction,  brightening, clipping, dithering, depth-
  35.      reduction, rotation, and zooming.  Most of  these  manipula-
  36.      tions have simple implementations; speed was opted for above
  37.      accuracy.
  38.  
  39.      If you are viewing a large image in a  window,  the  initial
  40.      window will be at most 90% of the size of the display unless
  41.      the window manager does not  correctly  handle  window  size
  42.      requests  or if you've used the -_f_u_l_l_s_c_r_e_e_n option.  You may
  43.      move the image around in the window  by  dragging  with  the
  44.      first  mouse  button.  The cursor will indicate which direc-
  45.      tions you may drag, if any.  You may exit the window by typ-
  46.      ing 'q' or '^C' when the keyboard focus is on the window.
  47.  
  48.      If more than one image file  is  specified  on  the  command
  49.      line, each image will be shown in order (except if -_m_e_r_g_e or
  50.      -_g_o_t_o are being used).
  51.  
  52.      A wide variety of common image manipulations can be done  by
  53.      mixing  and matching the available options.  See the section
  54.      entitled _H_I_N_T_S _F_O_R _G_O_O_D _I_M_A_G_E _D_I_S_P_L_A_Y_S for some ideas.
  55.  
  56.      The -_d_u_m_p option causes an image to be  written  to  a  file
  57.      rather  than displayed after processing.  This allows you to
  58.      read an image, perform a number of processing operations  on
  59.      it,   and  save  the  resultant  image.   This  also  allows
  60.  
  61.  
  62.  
  63. Sun Release 4.1      Last change: 8 May 1991                    1
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70. XLOADIMAGE(1)            USER COMMANDS              XLOADIMAGE(1)
  71.  
  72.  
  73.  
  74.      translation from any of the recognized image types into  any
  75.      of the formats that support dumping.
  76.  
  77.      _X_s_e_t_b_g is equivalent to _x_l_o_a_d_i_m_a_g_e -_o_n_r_o_o_t -_q_u_i_e_t and  _x_v_i_e_w
  78.      is equivalent to _x_l_o_a_d_i_m_a_g_e -_v_i_e_w -_v_e_r_b_o_s_e.
  79.  
  80. RESOURCE CLASS
  81.      _X_l_o_a_d_i_m_a_g_e uses the resource class name _X_l_o_a_d_i_m_a_g_e for  win-
  82.      dow  managers  which  need  this  resource  set.   This name
  83.      changed in version 2.00 and  2.01;  some  previous  versions
  84.      used the name _X_L_o_a_d_I_m_a_g_e (which was difficult to predict) or
  85.      _x_l_o_a_d_i_m_a_g_e (which conflicted with class naming conventions).
  86.  
  87. GLOBAL OPTIONS
  88.      The  following  options  affect  the  global  operation   of
  89.      _x_l_o_a_d_i_m_a_g_e.   They  may be specified anywhere on the command
  90.      line.  Additionally the -_g_l_o_b_a_l option can be used to  force
  91.      an image option to apply to all images.
  92.  
  93.      -border _c_o_l_o_r
  94.              This sets the background portion of the window which
  95.              is not covered by any images to be _c_o_l_o_r.
  96.  
  97.      -configuration
  98.              Displays the image path, image  suffixes,  and  sup-
  99.              ported  filters  which will be used when looking for
  100.              and  reading  images.    These   are   loaded   from
  101.              ~/.xloadimagerc  and  optionally  from  a systemwide
  102.              file   (normally    /usr/lib/xloadimagerc).     This
  103.              replaces the -path option.
  104.  
  105.      -default
  106.              Use the default  root  weave  as  the  image.   This
  107.              option  forces  -_o_n_r_o_o_t.  If -_d_e_f_a_u_l_t is used alone,
  108.              it is the same as _x_s_e_t_r_o_o_t with  no  arguments.   If
  109.              used  in  conjunction  with -_t_i_l_e this option can be
  110.              used to place images on the default root weave  (see
  111.              EXAMPLES below).
  112.  
  113.      -debug  Talk to the X server in synchronous mode.   This  is
  114.              useful  for  debugging.  If an X error is seen while
  115.              in this mode, a core will be dumped.
  116.  
  117.      -delay _s_e_c_s
  118.              Automatically advance to the next image  after  _s_e_c_s
  119.              seconds.
  120.  
  121.      -display _d_i_s_p_l_a_y__n_a_m_e
  122.              X11 display name to send the image(s) to.
  123.  
  124.      -dump _i_m_a_g_e__t_y_p_e[,_o_p_t_i_o_n[=_v_a_l_u_e]] _d_u_m_p__f_i_l_e
  125.              Rather than  displaying  the  loaded  and  processed
  126.  
  127.  
  128.  
  129. Sun Release 4.1      Last change: 8 May 1991                    2
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136. XLOADIMAGE(1)            USER COMMANDS              XLOADIMAGE(1)
  137.  
  138.  
  139.  
  140.              image,  dump  it into an image file of the specified
  141.              type.  For a list of image types that can be dumped,
  142.              use  the  -_s_u_p_p_o_r_t_e_d  option.  Some image types have
  143.              options that affect the format of  the  file  that's
  144.              created.   See  DUMP OPTIONS below.  An image can be
  145.              dumped in any supported dump  format  regardless  of
  146.              the original image type, so image file type transla-
  147.              tion is possible using this option.
  148.  
  149.      -fit    Force image to use the default visual and  colormap.
  150.              This  is  useful  if  you  do  not  want technicolor
  151.              effects when the colormap focus is inside the  image
  152.              window,  but  it  may  reduce  the  quality  of  the
  153.              displayed image.  This is on by default  if  -onroot
  154.              or -windowid is specified.
  155.  
  156.      -fork   Fork xloadimage.  This causes xloadimage to disasso-
  157.              ciate  itself from the shell.  This option automati-
  158.              cally turns on -quiet.
  159.  
  160.      -fullscreen
  161.              Use the entire screen to display  images.   If  com-
  162.              bined with -onroot, the image will be zoomed to fill
  163.              the entire rootwindow.
  164.  
  165.      -geometry _W_x_H[{+-_X}{+-}_Y]
  166.              This sets the size of  the  window  onto  which  the
  167.              images are loaded to a different value than the size
  168.              of the image.  When viewing an image  in  a  window,
  169.              this  can be used to reduce the size of the destina-
  170.              tion window.  When loading an image  onto  the  root
  171.              window,  this option controls the size of the pixmap
  172.              which will be loaded onto the root.  If the size  is
  173.              smaller  than that of the display, the image will be
  174.              replicated.
  175.  
  176.      -goto image_name
  177.              Forces the next image to  be  displayed  to  be  the
  178.              image named _i_m_a_g_e__n_a_m_e.  This is useful for generat-
  179.              ing looped slideshows.  If more than  one  image  of
  180.              the  same  name as the target exists on the argument
  181.              list, the first in the argument list is used.
  182.  
  183.      -help [option ...]
  184.              Give information on an option or  list  of  options.
  185.              If  no  option  is  given, a simple interactive help
  186.              facility is invoked.
  187.  
  188.      -identify
  189.              Identify the supplied  images  rather  than  display
  190.              them.
  191.  
  192.  
  193.  
  194.  
  195. Sun Release 4.1      Last change: 8 May 1991                    3
  196.  
  197.  
  198.  
  199.  
  200.  
  201.  
  202. XLOADIMAGE(1)            USER COMMANDS              XLOADIMAGE(1)
  203.  
  204.  
  205.  
  206.      -install
  207.              Forcibly install the image's colormap when the  win-
  208.              dow  is  focused.  This violates ICCCM standards and
  209.              only exists to allow  operation  with  naive  window
  210.              managers.   Use  this  option  only  if  your window
  211.              manager does not install colormaps properly.
  212.  
  213.      -list   List the images which are along the image path.
  214.  
  215.      -onroot Load image(s) onto the root window instead of  view-
  216.              ing in a window.  This option automatically sets the
  217.              -fit option.  This is the opposite of -_v_i_e_w.  _X_S_e_t_b_g
  218.              has this option set by default.
  219.  
  220.      -path   Displays miscellaneous information about the program
  221.              configuration.  This option is obsolete and has been
  222.              replaced by -configuration.
  223.  
  224.      -pixmap Force the use of a pixmap as backing-store.  This is
  225.              provided  for  servers where backing-store is broken
  226.              (such as some versions of  the  AIXWindows  server).
  227.              It  may  improve  scrolling  performance  on servers
  228.              which provide backing-store.
  229.  
  230.      -private
  231.              Force the  use  of  a  private  colormap.   Normally
  232.              colors  are  allocated  shared  unless there are not
  233.              enough colors available.
  234.  
  235.      -quiet  Forces _x_l_o_a_d_i_m_a_g_e and _x_v_i_e_w to be  quiet.   This  is
  236.              the default for _x_s_e_t_b_g, but the others like to whis-
  237.              tle.
  238.  
  239.      -supported
  240.              List the supported image types.
  241.  
  242.      -type _t_y_p_e__n_a_m_e
  243.              Forces _x_l_o_a_d_i_m_a_g_e to try to load the image as a par-
  244.              ticular file type rather than trying to guess.  This
  245.              often improves load performance noticably.
  246.  
  247.      -verbose
  248.              Causes _x_l_o_a_d_i_m_a_g_e to be talkative, telling you  what
  249.              kind of image it's playing with and any special pro-
  250.              cessing that it has to do. This is the  default  for
  251.              _x_v_i_e_w and _x_l_o_a_d_i_m_a_g_e.
  252.  
  253.      -version
  254.              Print the version number and patchlevel of this ver-
  255.              sion of _x_l_o_a_d_i_m_a_g_e.
  256.  
  257.      -view   View image(s) in a window.  This is the opposite  of
  258.  
  259.  
  260.  
  261. Sun Release 4.1      Last change: 8 May 1991                    4
  262.  
  263.  
  264.  
  265.  
  266.  
  267.  
  268. XLOADIMAGE(1)            USER COMMANDS              XLOADIMAGE(1)
  269.  
  270.  
  271.  
  272.              -_o_n_r_o_o_t and the default for _x_v_i_e_w and _x_l_o_a_d_i_m_a_g_e.
  273.  
  274.      -visual _v_i_s_u_a_l__n_a_m_e
  275.              Force the use of a specific visual type  to  display
  276.              an  image.   Normally  _x_l_o_a_d_i_m_a_g_e  tries to pick the
  277.              best available image for a  particular  image  type.
  278.              The   available   visual  types  are:   DirectColor,
  279.              TrueColor, PseudoColor, StaticColor, GrayScale,  and
  280.              StaticGray.  Nonconflicting names may be abbreviated
  281.              and case is ignored.
  282.  
  283.      -windowid _h_e_x__w_i_n_d_o_w__i_d
  284.              Sets the background pixmap of  a  particular  window
  285.              ID.  The argument must be in hexadecimal and must be
  286.              preceeded by "0x" (_e_g -windowid 0x40000b.   This  is
  287.              intended  for  setting the background pixmap of some
  288.              servers which use untagged  virtual  roots  (_e_g  HP-
  289.              VUE), but can have other interesting applications.
  290.  
  291. IMAGE OPTIONS
  292.      The following options may preceed each image.  These options
  293.      are local to the image they preceed.
  294.  
  295.      -at _X,_Y
  296.           Indicates coordinates to load the image at on the  base
  297.           image.   If  this  is an option to the first image, and
  298.           the -_o_n_r_o_o_t option is  specified,  the  image  will  be
  299.           loaded at the given location on the display background.
  300.  
  301.      -background _c_o_l_o_r
  302.           Use _c_o_l_o_r  as  the  background  color  instead  of  the
  303.           default  (usually  white  but this depends on the image
  304.           type) if you are transferring a monochrome image  to  a
  305.           color display.
  306.  
  307.      -brighten _p_e_r_c_e_n_t_a_g_e
  308.           Specify a percentage multiplier  for  a  color  image's
  309.           colormap.   A  value  of more than 100 will brighten an
  310.           image, one of less than 100 will darken it.
  311.  
  312.      -center
  313.           Center the image on the base image loaded.  If this  is
  314.           an option to the first image, and the -_o_n_r_o_o_t option is
  315.           specified, the image will be centered  on  the  display
  316.           background.
  317.  
  318.      -clip _X,_Y,_W,_H
  319.           Clip the image before loading it.  _X and _Y  define  the
  320.           upper-left  corner of the clip area, and _W and _H define
  321.           the extents of the area.  A zero value for _W or _H  will
  322.           be interpreted as the remainder of the image.
  323.  
  324.  
  325.  
  326.  
  327. Sun Release 4.1      Last change: 8 May 1991                    5
  328.  
  329.  
  330.  
  331.  
  332.  
  333.  
  334. XLOADIMAGE(1)            USER COMMANDS              XLOADIMAGE(1)
  335.  
  336.  
  337.  
  338.      -colors _n
  339.           Specify the maximum number of  colors  to  use  in  the
  340.           image.   This  is a way to forcibly reduce the depth of
  341.           an image.
  342.  
  343.      -dither
  344.           Dither a color  image  to  monochrome  using  a  Floyd-
  345.           Steinberg dithering algorithm.  This happens by default
  346.           when viewing color  images  on  a  monochrome  display.
  347.           This  is  slower  than  -_h_a_l_f_t_o_n_e and affects the image
  348.           accuracy but usually looks much better.
  349.  
  350.      -foreground _c_o_l_o_r
  351.           Use _c_o_l_o_r as the foreground color instead of  black  if
  352.           you  are  transferring  a  monochrome  image to a color
  353.           display.  This can also be used  to  invert  the  fore-
  354.           ground and background colors of a monochrome image.
  355.  
  356.      -gamma _d_i_s_p_l_a_y__g_a_m_m_a
  357.           Specify the gamma  correction  for  the  display.   The
  358.           default  value  is  1.0, a typical display needs 2.0 to
  359.           2.5.
  360.  
  361.      -global
  362.           Force the following  option  to  apply  to  all  images
  363.           rather  than  one  specific image.  Local image options
  364.           will temporarily override  any  option  specified  with
  365.           -global.
  366.  
  367.      -gray
  368.           Convert an image to grayscale.   This  is  very  useful
  369.           when displaying colorful images on servers with limited
  370.           color capability.  It can also be  used  to  convert  a
  371.           bitmap  image  into  a  grayscale  image,  although the
  372.           resulting image will be smaller than the original.  The
  373.           optional spelling -_g_r_e_y may also be used.
  374.  
  375.      -halftone
  376.           Force halftone dithering of a color image when display-
  377.           ing on a monochrome display.  This option is ignored on
  378.           monochrome images.  This dithering algorithm  blows  an
  379.           image  up by sixteen times; if you don't like this, the
  380.           -_d_i_t_h_e_r option will not blow the image up but will take
  381.           longer to process and will be less accurate.
  382.  
  383.      -idelay _s_e_c_s
  384.           Set the delay to be used for this image to _s_e_c_s seconds
  385.           (see  -_d_e_l_a_y).  If -_d_e_l_a_y was specified, this overrides
  386.           it.  If it was not specified, this sets  the  automatic
  387.           advance delay for this image while others will wait for
  388.           the user to advance them.
  389.  
  390.  
  391.  
  392.  
  393. Sun Release 4.1      Last change: 8 May 1991                    6
  394.  
  395.  
  396.  
  397.  
  398.  
  399.  
  400. XLOADIMAGE(1)            USER COMMANDS              XLOADIMAGE(1)
  401.  
  402.  
  403.  
  404.      -invert
  405.           Inverts a monochrome  image.   This  is  shorthand  for
  406.           -_f_o_r_e_g_r_o_u_n_d _w_h_i_t_e -_b_a_c_k_g_r_o_u_n_d _b_l_a_c_k.
  407.  
  408.      -merge
  409.           Merge this image onto the base image after  local  pro-
  410.           cessing.   The base image is considered to be the first
  411.           image specified or the last image  that  was  not  pre-
  412.           ceeded  by -_m_e_r_g_e.  If used in conjunction with -_a_t and
  413.           -_c_l_i_p, very complex  images  can  be  built  up.   This
  414.           option  is  on by default for all images if the -_o_n_r_o_o_t
  415.           or -_w_i_n_d_o_w_i_d options are specified.
  416.  
  417.      -name _i_m_a_g_e__n_a_m_e
  418.           Force the next argument to be treated as an image name.
  419.           This is useful if the name of the image is -_d_i_t_h_e_r, for
  420.           instance.
  421.  
  422.      -newoptions
  423.           Reset globally-specified options.
  424.  
  425.      -normalize
  426.           Normalize a color image.
  427.  
  428.      -rotate _d_e_g_r_e_e_s
  429.           Rotate the image by _d_e_g_r_e_e_s clockwise.  The number must
  430.           be a multiple of 90.
  431.  
  432.      -shrink
  433.           Shrink an image down to fit on the  display.   This  is
  434.           particularly  useful  with  servers that do not support
  435.           window  sizes  larger  than  the  physical  screen  (eg
  436.           DECWINDOWS servers).
  437.  
  438.      -smooth
  439.           Smooth a color image.  This  reduces  blockiness  after
  440.           zooming  an  image  up.  If used on a monochrome image,
  441.           nothing happens.  This option can take awhile  to  per-
  442.           form, especially on large images.  You may specify more
  443.           than one -_s_m_o_o_t_h option  per  image,  causing  multiple
  444.           iterations of the smoothing algorithm.
  445.  
  446.      -tile
  447.           Tile this image (after any necessary merging or tiling)
  448.           to  create a fullscreen image.  This is usually used to
  449.           create a large background image on which to merge other
  450.           images.   -_g_e_o_m_e_t_r_y  can  be  used to set the new image
  451.           size to something other than -fullscreen.
  452.  
  453.      -title _t_i_t_l_e
  454.           Change the title of the image.  This sets the title bar
  455.           title  if displaying in a window or the NIFF file image
  456.  
  457.  
  458.  
  459. Sun Release 4.1      Last change: 8 May 1991                    7
  460.  
  461.  
  462.  
  463.  
  464.  
  465.  
  466. XLOADIMAGE(1)            USER COMMANDS              XLOADIMAGE(1)
  467.  
  468.  
  469.  
  470.           title if dumping the image.
  471.  
  472.      -xzoom _p_e_r_c_e_n_t_a_g_e
  473.           Zoom the X axis of an image by  _p_e_r_c_e_n_t_a_g_e.   A  number
  474.           greater  than  100  will  expand the image, one smaller
  475.           will compress it.  A zero value will be ignored.   This
  476.           option,  and the related -_y_z_o_o_m are useful for correct-
  477.           ing the aspect ratio of images to be displayed.
  478.  
  479.      -yzoom _p_e_r_c_e_n_t_a_g_e
  480.           Zoom the Y axis of an image by _p_e_r_c_e_n_t_a_g_e.  See  -_x_z_o_o_m
  481.           for more information.
  482.  
  483.      -zoom _p_e_r_c_e_n_t_a_g_e
  484.           Zoom both the X and Y axes by _p_e_r_c_e_n_t_a_g_e.   See  -_x_z_o_o_m
  485.           for more information.  Technically the percentage actu-
  486.           ally zoomed is the square of the number supplied  since
  487.           the  zoom  is to both axes, but I opted for consistency
  488.           instead of accuracy.
  489.  
  490. EXAMPLES
  491.      To load the rasterfile "my.image" onto  the  background  and
  492.      replicate it to fill the entire background:
  493.  
  494.           xloadimage -onroot my.image
  495.  
  496.      To center an image on the default root background:
  497.  
  498.           xloadimage -default -tile my.image
  499.  
  500.      If using a monochrome display and a  color  image  you  will
  501.      probably want to dither the image for a cleaner (and faster)
  502.      display:
  503.  
  504.           xloadimage -default -tile -dither my.image
  505.  
  506.      To load a monochrome image "my.image" onto  the  background,
  507.      using  red as the foreground color, replicate the image, and
  508.      overlay "another.image" onto it at coordinate (10,10):
  509.  
  510.           xloadimage   -foreground   red   my.image   -at   10,10
  511.      another.image
  512.  
  513.      To center the rectangular region from 10 to 110 along the  X
  514.      axis  and  from  10  to  the height of the image along the Y
  515.      axis:
  516.  
  517.           xloadimage -center -clip 10,10,100,0 my.image
  518.  
  519.      To double the size of an image:
  520.  
  521.           xloadimage -zoom 200 my.image
  522.  
  523.  
  524.  
  525. Sun Release 4.1      Last change: 8 May 1991                    8
  526.  
  527.  
  528.  
  529.  
  530.  
  531.  
  532. XLOADIMAGE(1)            USER COMMANDS              XLOADIMAGE(1)
  533.  
  534.  
  535.  
  536.      To halve the size of an image:
  537.  
  538.           xloadimage -zoom 50 my.image
  539.  
  540.      To brighten a dark image:
  541.  
  542.           xloadimage -brighten 150 my.image
  543.  
  544.      To darken a bright image:
  545.  
  546.           xloadimage -brighten 50 my.image
  547.  
  548. HINTS FOR GOOD IMAGE DISPLAYS
  549.      Since images are likely to come from a variety  of  sources,
  550.      they  may  be in a variety of aspect ratios which may not be
  551.      supported by your display.  The -_x_z_o_o_m  and  -_y_z_o_o_m  options
  552.      can  be  used  to change the aspect ratio of an image before
  553.      display.  If you use these options, it is  recommended  that
  554.      you  increase  the  size of one of the dimensions instead of
  555.      shrinking the other, since  shrinking  looses  detail.   For
  556.      instance,  many  GIF  and G3 FAX images have an X:Y ratio of
  557.      about 2:1.  You can  correct  this  for  viewing  on  a  1:1
  558.      display  with  either -_x_z_o_o_m _5_0 or -_y_z_o_o_m _2_0_0 (reduce X axis
  559.      to 50% of its size and expand Y axis to 200%  of  its  size,
  560.      respectively)  but the latter should be used so no detail is
  561.      lost in the conversion.
  562.  
  563.      When zooming color images up you can reduce blockiness  with
  564.      -_s_m_o_o_t_h.  For zooms of 300% or more, I recommend two smooth-
  565.      ing passes (although this can take  awhile  to  do  on  slow
  566.      machines).   There  will  be  a noticable improvement in the
  567.      image.
  568.  
  569.      You can perform image processing on a small  portion  of  an
  570.      image  by  loading  the  image  more than once and using the
  571.      -_m_e_r_g_e, -_a_t and -_c_l_i_p options.  Load the image,  then  merge
  572.      it with a clipped, processed version of itself.  To brighten
  573.      a  100x100  rectangular  portion  of  an  image  located  at
  574.      (50,50), for instance, you could type:
  575.  
  576.           xloadimage   my.image   -merge    -at    50,50    -clip
  577.      50,50,100,100 -brighten 150 my.image
  578.  
  579.      If you're using a display with a small colormap  to  display
  580.      colorful  images,  try  using the -_g_r_a_y option to convert to
  581.      grayscale.
  582.  
  583. PATHS AND EXTENSIONS
  584.      The file ~/.xloadimagerc (and optionally a system-wide file)
  585.      defines  a  number  of  configuration  options  that  affect
  586.      xloadimage.
  587.  
  588.  
  589.  
  590.  
  591. Sun Release 4.1      Last change: 8 May 1991                    9
  592.  
  593.  
  594.  
  595.  
  596.  
  597.  
  598. XLOADIMAGE(1)            USER COMMANDS              XLOADIMAGE(1)
  599.  
  600.  
  601.  
  602.      This file is split into three section, the _p_a_t_h section, the
  603.      _e_x_t_e_n_s_i_o_n section, and the _f_i_l_t_e_r section.  The sections are
  604.      identified by typing the section name followed by an  equals
  605.      sign, eg "path =".
  606.  
  607.      The _p_a_t_h statement is used to provide a set of search  paths
  608.      to  use  when  looking  for  an  image  of a specified name.
  609.      Separate each path in the list by whitespace (eg one or more
  610.      spaces,  tabs,  or  newlines).   The path is searched in the
  611.      order it is specified.  For example:
  612.  
  613.        path = ~/images /usr/local/images ~fred
  614.  
  615.      will first look for the image name you specified, then  look
  616.      for the name in ~/images (the tilde is expanded to the value
  617.      of $HOME), then in /usr/local/images, then  in  user  fred's
  618.      home directory.  This allows easy use of image repositories.
  619.  
  620.      The _e_x_t_e_n_s_i_o_n statement is used to provide a set of  default
  621.      extensions  to  use when looking for an image of a specified
  622.      name.  Separate each extension in the  list  by  whitespace.
  623.      The  extensions  are searched in the order in which they are
  624.      specified.  For example:
  625.  
  626.        extension = .gif .jpg
  627.  
  628.      If you have a file named _m_y_i_m_a_g_e._g_i_f you could  specify  the
  629.      name  _m_y_i_m_a_g_e and xloadimage would append the ._g_i_f extension
  630.      automatically.
  631.  
  632.      The _f_i_l_t_e_r statement is used to  describe  filter  programs,
  633.      such as "uncompress", which are to be applied to image files
  634.      automatically.  You  specify  one  filter  program  and  any
  635.      number  of  recognized  extensions following the _f_i_l_t_e_r key-
  636.      word.  For example:
  637.  
  638.        filter = uncompress .Z
  639.  
  640.      specifies that the program _u_n_c_o_m_p_r_e_s_s should be  used  as  a
  641.      filter  whenever  an  image  file  has  a  .Z extension.  By
  642.      default filters are provided for compressed (.Z)  files  and
  643.      GNU  zip  (.gz)  files.   See  the  FILTERS section for more
  644.      information on defining your own filters.
  645.  
  646.      Any text on a line following a hash-mark (#) is ignored;  if
  647.      you  wish to use a hash-mark in a path, extension, or filter
  648.      you can escape it using a backslash (\).
  649.  
  650.      If you wish to include white-space in a filter program name,
  651.      path,  or  extension  you  can  enclose  the  entire text in
  652.      double-quotes.  For example:
  653.  
  654.  
  655.  
  656.  
  657. Sun Release 4.1      Last change: 8 May 1991                   10
  658.  
  659.  
  660.  
  661.  
  662.  
  663.  
  664. XLOADIMAGE(1)            USER COMMANDS              XLOADIMAGE(1)
  665.  
  666.  
  667.  
  668.        filter = "gzip -cd" .gz
  669.  
  670.      Use backslash (\) characters to allow inclusion  of  double-
  671.      quote marks or newlines.
  672.  
  673.      The following is a sample ~/.xloadimagerc file:
  674.  
  675.        # paths to look for images in
  676.        path = /usr/local/images        # system image repository
  677.              ~/images                 # personal images
  678.              /usr/include/X11/bitmaps # standard X bitmaps
  679.  
  680.        # default extensions for images
  681.        extension = .csun .msun .sun .face .xbm .bm
  682.  
  683.        # invoke GNU zip if a .z or .zip extension is found
  684.        filter = "gzip -cd" .z .zip
  685.  
  686.  
  687. IMAGE TYPES
  688.      _X_l_o_a_d_i_m_a_g_e currently supports many common and some  uncommon
  689.      image  types, and can create images in several formats.  For
  690.      a complete list use the -_s_u_p_p_o_r_t_e_d option.
  691.  
  692. DUMPING IMAGES
  693.      Several image dumpers are  included  that  can  be  used  to
  694.      create  a  new image after loading and processing.  The NIFF
  695.      (Native Image File  Format)  is  the  simplest  and  creates
  696.      images  that  _x_l_o_a_d_i_m_a_g_e  can read the fastest; it is essen-
  697.      tially a copy of the internal image format.
  698.  
  699.      Some image dumpers allow options that affect the image  out-
  700.      put.  These options are appended to the image type following
  701.      a comma and are separated by commas.  If a value is  desired
  702.      it  can be specified following an equals-sign.  For example,
  703.      to create a monochrome JPEG image file with a quality factor
  704.      of 80, you would use the following command line:
  705.  
  706.        xloadimage image_name -dump jpeg,quality=80,grayscale new_image.jpg
  707.  
  708.      Option names can be abbreviated but if the  abbreviation  is
  709.      too  short  to  be  unique  the option which will be used is
  710.      indeterminate.
  711.  
  712. FILTERS
  713.      Xloadimage supports automatic filtering by recognizing  file
  714.      extensions.   By  default  "compress"  and  "gzip" files are
  715.      recognized and their names passed to appropriate commands to
  716.      decompress them.
  717.  
  718.      The  xloadimage  distribution  includes  a  special  "smart"
  719.      uudecoder, called _u_u_f_i_l_t_e_r that can be used to automatically
  720.  
  721.  
  722.  
  723. Sun Release 4.1      Last change: 8 May 1991                   11
  724.  
  725.  
  726.  
  727.  
  728.  
  729.  
  730. XLOADIMAGE(1)            USER COMMANDS              XLOADIMAGE(1)
  731.  
  732.  
  733.  
  734.      uudecode files for processing.  _U_u_f_i_l_t_e_r ignores  extraneous
  735.      lines  in the file so it is particularly useful if the uuen-
  736.      coded file was created by concatenating email or news  post-
  737.      ings that had headers or line-break indicators included.
  738.  
  739.      To make use of _u_u_f_i_l_t_e_r you can add the following to your
  740.  
  741.        filter = "uufilter -s" .uu .uue
  742.      The filter will be automatically invoked on any file with  a
  743.      .uu or
  744.  
  745.      For a list of filters automatically recognized by xloadimage
  746.      use the -_c_o_n_f_i_g_u_r_a_t_i_o_n option.
  747.  
  748. SUPPORTED IMAGE OPTIONS
  749.      The JPEG image dumper supports the following options:
  750.  
  751.      arithmetic
  752.              Use arithmetic encoding.
  753.  
  754.      grayscale
  755.              Force a monochrome (grayscale) image to  be  created
  756.              given a color image.
  757.  
  758.      nointerleave
  759.              Create a non-interleaved file.
  760.  
  761.      optimize
  762.              Enable entropy parameter optimization.
  763.  
  764.      quality Adjust the quality of the image to be created.   The
  765.              default  quality  factor  is 75; lower values create
  766.              poorer images.
  767.  
  768.      restart _i_n_t_e_r_v_a_l
  769.              Set the restart interval in MCU rows, or MCUs if 'b'
  770.              follows the interval value.
  771.  
  772.      smooth _s_m_o_o_t_h_i_n_g__f_a_c_t_o_r
  773.              Set the smoothing factor.  Value should be between 0
  774.              and 100, inclusive.
  775.  
  776.      If you are not familiar with the meaning  of  these  options
  777.      you  can  ask  the Independent JPEG Group (IJG) via email at
  778.      jpeg@cs.columbia.edu.
  779.  
  780.      The PBM image dumper supports the following options:
  781.  
  782.      normal  Dump a normal (ascii) PBM/PPM file.
  783.  
  784.      raw     Dump a RawBits format PBM/PPM  file.   This  is  the
  785.              default  and  results in significantly smaller image
  786.  
  787.  
  788.  
  789. Sun Release 4.1      Last change: 8 May 1991                   12
  790.  
  791.  
  792.  
  793.  
  794.  
  795.  
  796. XLOADIMAGE(1)            USER COMMANDS              XLOADIMAGE(1)
  797.  
  798.  
  799.  
  800.              files than when using _n_o_r_m_a_l.
  801.  
  802.      There is no way to dump a PGM format file or a "compact" PBM
  803.      format file (sorry).
  804.  
  805.      The TIFF image dumper supports the following options:
  806.  
  807.      compression
  808.              Image data compression technique.  Can  be  one  of:
  809.              _n_o_n_e  (no compression), _r_l_e (CCITT RLE compression),
  810.              _g_3_f_a_x (CCITT Group 3 FAX compression), _g_4_f_a_x  (CCITT
  811.              Group  4  FAX  compression),  _l_z_w  (Limpel-Ziv-Welsh
  812.              compression, the default), _j_p_e_g (JPEG  compression),
  813.              _n_e_x_t (NeXT run-length compression), _r_l_e_w (CCITT RLEW
  814.              compression), _m_a_c (Macintosh PackBits  compression),
  815.              _p_a_c_k_b_i_t_s  (same  as  _m_a_c),  _t_h_u_n_d_e_r_s_c_a_n (ThunderScan
  816.              compression).
  817.  
  818.      _X_l_o_a_d_i_m_a_g_e  will  save  using  the  MINISBLACK,  MINISWHITE,
  819.      COLORMAP,  or RGB photometrics as appropriate for its inter-
  820.      nal image format.  There is no way to specify  a  particular
  821.      photometric or any other TIFF fields.
  822.  
  823. AUTHOR
  824.      Jim Frost
  825.      CenterLine Software
  826.      jimf@centerline.com
  827.  
  828.      For a  more-or-less  complete  list  of  other  contributors
  829.      (there  are  a  _l_o_t  of  them),  please  see the README file
  830.      enclosed with the distribution.
  831.  
  832. FILES
  833.           xloadimage              - the image loader and viewer
  834.           xsetbg                  - pseudonym which quietly sets the background
  835.           xview                   - pseudonym which views in a window
  836.           /usr/lib/X11/Xloadimage - default system-wide configuration file
  837.           ~/.xloadimagerc         - user's personal configuration file
  838.  
  839. COPYRIGHT
  840.      Copyright (c) 1989, 1993 Jim Frost and others.
  841.  
  842.      _X_l_o_a_d_i_m_a_g_e is copywritten material with a very  loose  copy-
  843.      right  allowing  unlimited  modification and distribution if
  844.      the copyright notices are left intact.  Various portions are
  845.      copywritten by various people, but all use a modification of
  846.      the MIT copyright notice.  Please check the source for  com-
  847.      plete  copyright  information.   The  intent  is to keep the
  848.      source free, not to stifle its distribution, so please write
  849.      to me if you have any questions.
  850.  
  851.  
  852.  
  853.  
  854.  
  855. Sun Release 4.1      Last change: 8 May 1991                   13
  856.  
  857.  
  858.  
  859.  
  860.  
  861.  
  862. XLOADIMAGE(1)            USER COMMANDS              XLOADIMAGE(1)
  863.  
  864.  
  865.  
  866. BUGS
  867.      Zooming dithered images, especially downwards, is UGLY.
  868.  
  869.      Images can come in a variety of aspect  ratios.   _X_l_o_a_d_i_m_a_g_e
  870.      cannot  detect  what aspect ratio the particular image being
  871.      loaded has, nor the aspect ratio of the destination display,
  872.      so  images with differing aspect ratios from the destination
  873.      display will appear distorted.  See  _H_I_N_T_S  _F_O_R  _G_O_O_D  _I_M_A_G_E
  874.      _D_I_S_P_L_A_Y_S for more information.
  875.  
  876.      The GIF format allows more than one image to be stored in  a
  877.      single GIF file, but _x_l_o_a_d_i_m_a_g_e will only display the first.
  878.  
  879.      Only GIF87a format is supported.
  880.  
  881.      One of the pseudonyms for _x_l_o_a_d_i_m_a_g_e,  _x_v_i_e_w,  is  the  same
  882.      name  as  Sun  uses for their SunView-under-X package.  This
  883.      will be confusing if you're one of those poor souls who  has
  884.      to use Sun's XView.
  885.  
  886.      Some window managers do not  correctly  handle  window  size
  887.      requests.   In  particular,  many versions of the twm window
  888.      manager use the MaxSize hint  instead  of  the  PSize  hint,
  889.      causing  images  which are larger than the screen to display
  890.      in a window larger than the screen, something which is  nor-
  891.      mally avoided.  Some versions of twm also ignore the MaxSize
  892.      argument's real function, to limit the maximum size  of  the
  893.      window,  and  allow the window to be resized larger than the
  894.      image.  If this happens, _x_l_o_a_d_i_m_a_g_e merely places the  image
  895.      in  the  upper-left  corner of the window and uses the zero-
  896.      value'ed pixel for any space which is  not  covered  by  the
  897.      image.   This behavior is less-than-graceful but so are win-
  898.      dow managers which are cruel enough to ignore such details.
  899.  
  900.  
  901.  
  902.  
  903.  
  904.  
  905.  
  906.  
  907.  
  908.  
  909.  
  910.  
  911.  
  912.  
  913.  
  914.  
  915.  
  916.  
  917.  
  918.  
  919.  
  920.  
  921. Sun Release 4.1      Last change: 8 May 1991                   14
  922.  
  923.  
  924.  
  925.