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

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