annotate toolboxes/graph_visualisation/share/man/man1/lefty.1 @ 0:e9a9cd732c1e tip

first hg version after svn
author wolffd
date Tue, 10 Feb 2015 15:05:51 +0000
parents
children
rev   line source
wolffd@0 1 .TH LEFTY 1
wolffd@0 2 .SH NAME
wolffd@0 3 lefty \- A Programmable Graphics Editor
wolffd@0 4 .SH SYNOPSIS
wolffd@0 5 .B lefty
wolffd@0 6 [
wolffd@0 7 .I options
wolffd@0 8 ] [
wolffd@0 9 .I file
wolffd@0 10 ]
wolffd@0 11 .SH DESCRIPTION
wolffd@0 12 .B lefty
wolffd@0 13 is a two-view graphics editor for technical pictures. This editor has
wolffd@0 14 no hardwired knowledge about specific picture layouts or editing operations.
wolffd@0 15 Each picture is described by a program that contains functions to draw the
wolffd@0 16 picture and functions to perform editing operations that are appropriate for
wolffd@0 17 the specific picture. Primitive user actions, like mouse and keyboard events,
wolffd@0 18 are also bound to functions in this program. Besides the graphical view of the
wolffd@0 19 picture itself, the editor presents a textual view of the program that
wolffd@0 20 describes the picture. Programmability and the two-view interface allow the
wolffd@0 21 editor to handle a variety of pictures, but are particularly useful for
wolffd@0 22 pictures used in technical contexts, e.g., graphs and trees. Also,
wolffd@0 23 .B lefty
wolffd@0 24 can communicate with other processes. This feature allows it to use existing
wolffd@0 25 tools to compute specific picture layouts and allows external processes to use
wolffd@0 26 the editor as a front end to display their data structures graphically.
wolffd@0 27 .SH USAGE
wolffd@0 28 The file name is optional. It may be
wolffd@0 29 .BR - ,
wolffd@0 30 for reading from standard input.
wolffd@0 31 .B lefty
wolffd@0 32 uses two environment variables,
wolffd@0 33 .B LEFTYPATH
wolffd@0 34 and
wolffd@0 35 .BR LEFTYOPTIONS .
wolffd@0 36 .B LEFTYPATH
wolffd@0 37 is a colon separated list of directories. When
wolffd@0 38 .B lefty
wolffd@0 39 tries to open a file, it searches that path for the file. When
wolffd@0 40 .B lefty
wolffd@0 41 tries to start up another process, it searches
wolffd@0 42 .B LEFTYPATH
wolffd@0 43 first, then the standard
wolffd@0 44 .B PATH
wolffd@0 45 variable.
wolffd@0 46 .B LEFTYOPTIONS
wolffd@0 47 can be used to set specific options. Options specified on the command line
wolffd@0 48 override options set through this variable.
wolffd@0 49 .SH OPTIONS
wolffd@0 50 .TP
wolffd@0 51 .B -x
wolffd@0 52 Instructs the editor to exit after processing
wolffd@0 53 .BR file .
wolffd@0 54 .TP
wolffd@0 55 .B "-e <expression>"
wolffd@0 56 .B <expression>
wolffd@0 57 is parsed and executed.
wolffd@0 58 .TP
wolffd@0 59 .B -el <num>
wolffd@0 60 Set error reporting level. The default value is
wolffd@0 61 .BR 0 .
wolffd@0 62 .B 0
wolffd@0 63 never prints any messages.
wolffd@0 64 .B 1
wolffd@0 65 prints severe errors, such as trying to return from a non function.
wolffd@0 66 .B 2
wolffd@0 67 is the most useful: it reports function calls that cannot be executed, either
wolffd@0 68 because there is no function, or because of argument mismatches.
wolffd@0 69 .B 3
wolffd@0 70 also warns about bad variable names.
wolffd@0 71 .B 4,5
wolffd@0 72 warn about expressions that do not return a value. Only level
wolffd@0 73 .B 1
wolffd@0 74 messages are real errors. The rest arise from legal
wolffd@0 75 .B lefty
wolffd@0 76 statements, but may be cased by some logic errors.
wolffd@0 77 .TP
wolffd@0 78 .B "-sd <num>"
wolffd@0 79 Specifies how much of the stack to show, when an error message is to be
wolffd@0 80 printed. The default value is
wolffd@0 81 .BR 2 .
wolffd@0 82 With
wolffd@0 83 .BR 0 ,
wolffd@0 84 no part of the stack is shown. With
wolffd@0 85 .BR 1 ,
wolffd@0 86 only the top stack frame is printed. With
wolffd@0 87 .BR 2 ,
wolffd@0 88 the full stack is printed.
wolffd@0 89 .TP
wolffd@0 90 .B "-sb <num>"
wolffd@0 91 Specifies how much of each function in the stack to show, when an error message
wolffd@0 92 is to be printed. The default value is
wolffd@0 93 .BR 2 .
wolffd@0 94 With
wolffd@0 95 .BR 0 ,
wolffd@0 96 no part of the function is shown. With
wolffd@0 97 .BR 1 ,
wolffd@0 98 only the line around the error is printed. With
wolffd@0 99 .BR 2 ,
wolffd@0 100 the full function body is printed.
wolffd@0 101 .TP
wolffd@0 102 .B "-df <string>"
wolffd@0 103 Sets the default font. This font is used whenever a requested font cannot be
wolffd@0 104 found. The string must be a legal X font. If string is
wolffd@0 105 .BR "''" ,
wolffd@0 106 .B lefty
wolffd@0 107 will draw small boxes instead of text.
wolffd@0 108 .TP
wolffd@0 109 .B "-ps <file>"
wolffd@0 110 Specifies a default file name for postscript files. This name is used when no
wolffd@0 111 name is specified in the
wolffd@0 112 .B createwidget
wolffd@0 113 call. The default file name is
wolffd@0 114 .BR out.ps .
wolffd@0 115 .TP
wolffd@0 116 .B -V
wolffd@0 117 Prints the version.
wolffd@0 118 .SH SEE ALSO
wolffd@0 119 .I lefty
wolffd@0 120 user guide.