home *** CD-ROM | disk | FTP | other *** search
/ Skunkware 5 / Skunkware 5.iso / src / X11 / xtartan-2.0 / xtartan.doc < prev    next >
Encoding:
Text File  |  1995-05-24  |  18.8 KB  |  463 lines
  1.  
  2.  
  3.  
  4.      XXXXTTTTAAAARRRRTTTTAAAANNNN((((GGGG))))               UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV                XXXXTTTTAAAARRRRTTTTAAAANNNN((((GGGG))))
  5.  
  6.  
  7.  
  8.      NNNNAAAAMMMMEEEE
  9.           xtartan - draw various tartans as window backgrounds
  10.  
  11.  
  12.      SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  13.           xxxxttttaaaarrrrttttaaaannnn [-draw] [-list] [-print] [-version] [-r] [-s scale]
  14.           [-t tartanname] [-w linewidth] [-np namepattern] [-sp
  15.           setpattern]
  16.  
  17.  
  18.      DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  19.           _X_t_a_r_t_a_n generates a pixmap containing a Scottish tartan and
  20.           sets it as the background of a new window (or the root
  21.           window if -r is used).  Tartan sett information and color
  22.           information are specified using X11 resources, allowing you
  23.           to easily add your own tartan if it is not already included,
  24.           or to modify the pattern or individual colors of existing
  25.           tartans.
  26.  
  27.           The standard applications default file for Xtartan includes
  28.           descriptions for over 240 setts.
  29.  
  30.  
  31.      OOOOPPPPTTTTIIIIOOOONNNNSSSS
  32.           ----ddddrrrraaaawwww
  33.                Draw the tartan as a window background (the default
  34.                action).
  35.  
  36.           ----lllliiiisssstttt
  37.                Print out a list of the names of all of the available
  38.                tartans.
  39.  
  40.           ----pppprrrriiiinnnntttt
  41.                Print out the sett information for the specified
  42.                tartan.
  43.  
  44.           ----vvvveeeerrrrssssiiiioooonnnn
  45.                Print out the version number of the xtartan program.
  46.  
  47.           ----rrrr   Display on the root window instead of creating a new
  48.                window.
  49.  
  50.           ----ssss   Scale up the width of the stripes in the tartan by the
  51.                specified integer (default 2).
  52.  
  53.           ----wwww   Scale up with width of the lines drawn by the specified
  54.                integer.
  55.  
  56.           ----tttt   Use the specified tartan.  If not specified, the
  57.                MacBeth tartan is used.
  58.  
  59.           ----nnnnpppp  Use the specified name pattern to filter tartans for
  60.  
  61.  
  62.  
  63.      Page 1                                          (printed 2/21/91)
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70.      XXXXTTTTAAAARRRRTTTTAAAANNNN((((GGGG))))               XXXXEEEENNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV                XXXXTTTTAAAARRRRTTTTAAAANNNN((((GGGG))))
  71.  
  72.  
  73.  
  74.                -list and when cycling through the tartans.  Only
  75.                tartans which contain the specified string as a
  76.                substring of the name will be used.
  77.  
  78.           ----sssspppp  Use the specified sett pattern to filter tartans for
  79.                -list and when cycling through the tartans.  Only
  80.                tartans which contain the specified string as a
  81.                substring of the sett will be used.
  82.  
  83.           XXXXtttt sssswwwwiiiittttcccchhhheeeessss
  84.                In addition to the above switches, any of the standard
  85.                top-level switches for the Xt toolkit can be specified
  86.                (such as -display).
  87.  
  88.  
  89.      RRRREEEESSSSOOOOUUUURRRRCCCCEEEESSSS
  90.           In addition to standard Xt toolkit resources, xtartan looks
  91.           for the resources described below. All resources are
  92.           application resources (xtartan.<resource>).
  93.  
  94.           aaaaccccttttiiiioooonnnn
  95.                Type String, class Action.  Specifies the action to
  96.                take; one of "draw", "print", "list", or "version".
  97.                Setting the action to one of these is equivalent to
  98.                specifying the command line option of the same name.
  99.  
  100.           ccccoooolllloooorrrrCCCCooooddddeeee....<<<<ccccooooddddeeeennnnaaaammmmeeee>>>>
  101.                Type String, class ColorCode.  Specifies the color name
  102.                translation for the indicated color code.  Color codes
  103.                are used in the sett descriptions.  For example, if the
  104.                sett used "BK4" and the resource "*.colorCode.BK:
  105.                Black" was specified, the BK4 would be drawn as a black
  106.                stripe of width four.  By specifying a resource such as
  107.                "XTartan.colorCode.BK: Grey" in your personal resources
  108.                (or with the -xrm command line option), you can
  109.                override the translation of the BK color code and make
  110.                it come out as Grey instead of Black.
  111.  
  112.           ffffiiiirrrrssssttttTTTTaaaarrrrttttaaaannnn
  113.                Type String, class firstTartan (sic - no
  114.                capitalization).  Specifies the name of the first
  115.                tartan in the list of tartans.  All tartan sett
  116.                information is specified in resources.  See the
  117.                descriptions of the sett and nextTartan resources.
  118.  
  119.           lllliiiinnnneeeeWWWWiiiiddddtttthhhh
  120.                Type Int, class LineWidth.  Specifies the line width
  121.                factor.  Equivalent to the "-w" command line option.
  122.  
  123.           <<<<ttttaaaarrrrttttaaaannnnnnnnaaaammmmeeee>>>>....nnnneeeexxxxttttTTTTaaaarrrrttttaaaannnn
  124.                Type String, class nextTartan (sic - no
  125.                capitalization).  Specifies the name of the next tartan
  126.  
  127.  
  128.  
  129.      Page 2                                          (printed 2/21/91)
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136.      XXXXTTTTAAAARRRRTTTTAAAANNNN((((GGGG))))               XXXXEEEENNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV                XXXXTTTTAAAARRRRTTTTAAAANNNN((((GGGG))))
  137.  
  138.  
  139.  
  140.                in the list of tartans.  The chain of tartans starts
  141.                with the tartan specified with the firstTartan resource
  142.                and goes through each nextTartan resource.  When
  143.                Xtartan starts up, it reads the chain into memory so
  144.                that it can go forwards or backwards in the list.  You
  145.                can add your own tartan into the middle of the chain by
  146.                overriding the nextTartan resource of the tartan
  147.                preceding your tartan (to refer to your tartan) and by
  148.                specifying the nextTartan resource on your new tartan
  149.                to refer to the tartan formerly referred to by the
  150.                preceding tartan.  For example, if you wanted to add
  151.                the tartan Foobar between Fletcher and Forbes, you
  152.                could do this by specifying the following resources in
  153.                your personal resources:
  154.  
  155.                XTartan.Fletcher.nextTartan: Foobar
  156.                XTartan.Foobar.sett: B4 R4 (a simple sett)
  157.                XTartan.Foobar.nextTartan: Forbes
  158.  
  159.                You should run xtartan with the -list option after
  160.                adding a tartan to make sure you have not broken the
  161.                chain.
  162.  
  163.           ssssccccaaaalllleeee
  164.                Type Int, class Scale.  Specifies the scale factor.
  165.                Equivalent to the "-s" command line option.
  166.  
  167.           <<<<ttttaaaarrrrttttaaaannnnnnnnaaaammmmeeee>>>>....sssseeeetttttttt
  168.                Type String, class sett (sic - no capitalization).
  169.                Specifies the sett information for the tartan.  Each
  170.                color stripe is represented by a color code immediately
  171.                followed by a thread count, e.g. BK4. The color code is
  172.                translated by the colorCode.<code> resource.  The sett
  173.                string can contain comments in parentheses (one level
  174.                only), and some special codes, which are preceded by a
  175.                percent character (%).  The special codes modify the
  176.                interpretation of the sett string as follows:
  177.  
  178.                %a - the sett is asymmetric (no pivots)
  179.                %b - all thread counts are even; they are divided
  180.                     by two when read in
  181.                %p - the last two colors are a double pivot
  182.                %v - vertical pattern (which follows) is different from
  183.                     horizontal pattern (which precedes)
  184.  
  185.                The sett pattern is drawn from left to right and from
  186.                bottom to top.
  187.  
  188.           ttttaaaarrrrttttaaaannnn
  189.                Type String, class Tartan.  Specifies the name of the
  190.                tartan to use.  Equivalent to the "-t" command line
  191.                option.
  192.  
  193.  
  194.  
  195.      Page 3                                          (printed 2/21/91)
  196.  
  197.  
  198.  
  199.  
  200.  
  201.  
  202.      XXXXTTTTAAAARRRRTTTTAAAANNNN((((GGGG))))               XXXXEEEENNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV                XXXXTTTTAAAARRRRTTTTAAAANNNN((((GGGG))))
  203.  
  204.  
  205.  
  206.           uuuusssseeeeRRRRooooooootttt
  207.                Type Boolean, class UseRoot.  If true, set the
  208.                background of the root window instead of opening a new
  209.                window.  Equivalent to the "-r" command line option.
  210.  
  211.  
  212.      IIIINNNNTTTTEEEERRRRAAAACCCCTTTTIIIIVVVVEEEE OOOOPPPPTTTTIIIIOOOONNNNSSSS
  213.           While xtartan is running, you can change tartans, scale, and
  214.           linewidth by entering keyboard command characters (except
  215.           when -r is used).  The actions defined in xtartan are listed
  216.           below, followed by the default translation bindings.
  217.  
  218.           eeeexxxxiiiitttt(((())))
  219.                Causes xtartan to exit.
  220.  
  221.           hhhheeeellllpppp(((())))
  222.                Prints out a list of what the standard translation
  223.                binding do.
  224.  
  225.           iiiinnnnffffoooo(((())))
  226.                Prints out the current tartan name, scale, and line
  227.                width.
  228.  
  229.           lllliiiinnnneeeeWWWWiiiiddddtttthhhh((((nnnneeeewwww))))
  230.                Changes the line width multiplier.  The argument is a
  231.                numeric string optionally preceded by a "+" or "-"
  232.                character.  If there is no sign character, then the new
  233.                number is used directly as the new line width.  If
  234.                there is a leading sign, then the new number is either
  235.                added or subtracted from the current value, and the
  236.                result is used as the new line width.
  237.  
  238.           nnnnaaaammmmeeee(((())))
  239.                Prints out the name of the current tartan.
  240.  
  241.           ssssccccaaaalllleeee((((nnnneeeewwww))))
  242.                Changes the scale multiplier.  The argument is a
  243.                numeric string and is interpreted in the same was as
  244.                for the lineWidth action.
  245.  
  246.           sssseeeettttTTTTaaaarrrrttttaaaannnn((((nnnnaaaammmmeeee))))
  247.                Switches the current tartan to the specified tartan.
  248.                If the name is "+", the next tartan in the list is
  249.                selected.  If the name is "-", the previous tartan in
  250.                the list is selected.  If the name is "0", the first
  251.                tartan in the list is selected.  For these specials,
  252.                the name and sett patterns are used to filter out
  253.                tartans which do not match those patterns.
  254.  
  255.           sssseeeetttttttt(((())))
  256.                Prints out the name and sett of the current tartan, and
  257.                translations for the color codes used in that sett.
  258.  
  259.  
  260.  
  261.      Page 4                                          (printed 2/21/91)
  262.  
  263.  
  264.  
  265.  
  266.  
  267.  
  268.      XXXXTTTTAAAARRRRTTTTAAAANNNN((((GGGG))))               XXXXEEEENNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV                XXXXTTTTAAAARRRRTTTTAAAANNNN((((GGGG))))
  269.  
  270.  
  271.  
  272.           The standard translation bindings (in the default app-
  273.           defaults file) are:
  274.  
  275.           Ctrl<Key>C : exit()\n\
  276.              :<Key>? : help()\n\
  277.              :<Key>h : help()\n\
  278.              :<Key>f : setTartan(0)\n\
  279.              :<Key>n : setTartan(+)\n\
  280.              :<Key>N : name()\n\
  281.              :<Key>p : setTartan(-)\n\
  282.              :<Key>P : sett()\n\
  283.              :<Key>q : exit()\n\
  284.              :<Key>t : info()\n\
  285.              :<Key>* : scale(+1)\n\
  286.              :<Key>/ : scale(-1)\n\
  287.              :<Key>+ : lineWidth(+1)\n\
  288.              :<Key>- : lineWidth(-1)\n\
  289.              :<Key>= : scale() lineWidth()
  290.  
  291.  
  292.      BBBBUUUUGGGGSSSS
  293.           When using line widths greater than one, there are often
  294.           alignment problems when abutting the tartan tiles, and you
  295.           can see a line delimiting the edge of the background pixmap
  296.           where the tartan lines do not match properly.
  297.  
  298.           Strange patterns can be caused by using line widths which
  299.           are large compared to the width of the color stripes in the
  300.           tartan.
  301.  
  302.           Not all of the "tartans" are actual tartans; some are random
  303.           patterns to test out the various drawing capabilities of the
  304.           program.
  305.  
  306.  
  307.      SSSSOOOOUUUURRRRCCCCEEEESSSS
  308.           The sett descriptions came from a number of different
  309.           sources.  The source for each sett in the app-defaults file
  310.           is indicated in a comment.  The following sources were used:
  311.  
  312.                "The Tartan Weaver's Guide" by James D. Scarlett, first
  313.                published 1985 by Shepheard-Walwyn (Publishers) Ltd.,
  314.                26 Charing Cross Road, London WC2H 0DH.  This book
  315.                contains color pictures of 142 tartans, and thread
  316.                counts for 228 tartans, plus a bit of history about
  317.                each tartan (but not about the people associated with
  318.                them).  It contains the notice, "Copyright (c)
  319.                Illustrations Shepheard-Walwyn (Publishers) Ltd. 1977."
  320.                I presume this means that the illustrations in this
  321.                book are copyrighted, but the sett information is not.
  322.                The setts listed in this source have been taken from a
  323.                number of other sources.  The source for each sett is
  324.  
  325.  
  326.  
  327.      Page 5                                          (printed 2/21/91)
  328.  
  329.  
  330.  
  331.  
  332.  
  333.  
  334.      XXXXTTTTAAAARRRRTTTTAAAANNNN((((GGGG))))               XXXXEEEENNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV                XXXXTTTTAAAARRRRTTTTAAAANNNN((((GGGG))))
  335.  
  336.  
  337.  
  338.                well documented, making this a good starting point if
  339.                you are interested in tracing the history of a
  340.                particular tartan.  Setts from this source are
  341.                indicated with (W) in the app-defaults file.
  342.  
  343.                "The Official Tartan map of tartans approved by clan
  344.                chiefs, the standing council of Scottish chiefs, or the
  345.                Lord Lyon King of Arms" by Dunbar and Pottinger,
  346.                published by Elm Tree Books in 1976.  (Entered by J.
  347.                Dean Brock (brock@cs.unc.edu)) Setts from this source
  348.                are indicated with (D) in the app-defaults file.
  349.  
  350.                "The Clans and Tartans of Scotland" by Robert Bain,
  351.                published by Collins, London and Glasgow, in 1950
  352.                (first published 1938). I find no copyright notice in
  353.                "The Clans..." nor any text restricting distribution of
  354.                information nor reserving rights in any manner.  This
  355.                book does not contains thread counts; thread colors and
  356.                counts for these setts have been estimated from the
  357.                photographs, so there is a good chance that they do not
  358.                exactly match any official sett.  Each tartan faces a
  359.                one page description of the history of the people
  360.                associated with the tartan.  Setts from this source are
  361.                indicated with (C) in the app-defaults file.
  362.  
  363.           Because of the difficulty of establishing the authenticity
  364.           of tartans, there are a great many tartans for which more
  365.           than one sett is listed.  These are listed with various
  366.           suffixes which generally indicated what authority was used
  367.           for that version of the tartan (e.g. _VS for tartans which
  368.           came from the Vestiarium Scoticum).
  369.  
  370.           In many cases, photographic plates show a sett which is
  371.           clearly not the same as the thread counts given.  Usually
  372.           the difference is in the size (thread count) for particular
  373.           stripes, or in the color of a stripe (e.g. white vs.
  374.           yellow).  When the difference was more than this, I have
  375.           included additional setts to reflect the photograph as well
  376.           as the printed sett.
  377.  
  378.           Please remember that the sett information here has been
  379.           manually transcribed from printed material, and
  380.           transcription errors may have occurred.  In some cases the
  381.           sources have contained errors, some in the printed thread
  382.           counts, some weaving errors in the photographic examples;
  383.           there may well be additional errors that I am not aware of.
  384.           I have done my best to ensure the correctness of the
  385.           information provided, but there are bound to be some errors
  386.           remaining.
  387.  
  388.           If you are serious about getting the correct definition for
  389.           a sett, please do a little research and find some
  390.  
  391.  
  392.  
  393.      Page 6                                          (printed 2/21/91)
  394.  
  395.  
  396.  
  397.  
  398.  
  399.  
  400.      XXXXTTTTAAAARRRRTTTTAAAANNNN((((GGGG))))               XXXXEEEENNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV                XXXXTTTTAAAARRRRTTTTAAAANNNN((((GGGG))))
  401.  
  402.  
  403.  
  404.           authoritative references.  The list above is a good start,
  405.           or you can go to your local library and look up "tartans" in
  406.           their subject index.
  407.  
  408.  
  409.      CCCCOOOOPPPPYYYYRRRRIIIIGGGGHHHHTTTT
  410.           This software is not copyrighted.
  411.  
  412.           Xtartan and the sett definitions that are included with it
  413.           have not been sanctioned by any Scottish authority; no
  414.           guarantee is placed on the accuracy of the tartans it
  415.           produces.
  416.  
  417.  
  418.      AAAAUUUUTTTTHHHHOOOORRRR
  419.           Jim McBeath
  420.           Globetrotter Software, Saratoga, California
  421.           jimmc@hisoft.uucp (Highland Software, Palo Alto)
  422.  
  423.  
  424.  
  425.  
  426.  
  427.  
  428.  
  429.  
  430.  
  431.  
  432.  
  433.  
  434.  
  435.  
  436.  
  437.  
  438.  
  439.  
  440.  
  441.  
  442.  
  443.  
  444.  
  445.  
  446.  
  447.  
  448.  
  449.  
  450.  
  451.  
  452.  
  453.  
  454.  
  455.  
  456.  
  457.  
  458.  
  459.      Page 7                                          (printed 2/21/91)
  460.  
  461.  
  462.  
  463.