"Fossies" - the Fresh Open Source Software Archive

Member "SAOImageDS9/tkcon/docs/tkconrc.5.man" (13 Nov 2019, 7897 Bytes) of package /linux/misc/ds9.8.1.tar.gz:


As a special service "Fossies" has tried to format the requested text file into HTML format (style: standard) with prefixed line numbers. Alternatively you can here view or download the uninterpreted source code file.

    1 [comment {-*- tcl -*- tkconrc manpage}]
    2 [manpage_begin tkconrc 5 2.5]
    3 [copyright {Jeffrey Hobbs <jeff at hobbs.org>}]
    4 [moddesc   {TkCon}]
    5 [titledesc {TkCon resource file}]
    6 
    7 [description]
    8 [para]
    9 TkCon will search for a resource file in [file ~/.tkconrc].
   10 TkCon never sources the [file ~/.wishrc] file.
   11 The resource file is sourced by each new instance of the console.
   12 An example resource file is provided below.
   13 
   14 [para]
   15 The file itself is a Tcl script, so it is required that the
   16 file conforms to Tcl script conventions.
   17 
   18 [section VARIABLES]
   19 [para]
   20 Certain variables in TkCon can be modified to suit your needs.
   21 It's easiest to do this in the resource file, but you can do
   22 it when time the program is running (and some can be changed
   23 via the [arg Prefs] menu).
   24 All these are part of the master interpreter's [cmd ::tkcon]
   25 namespace.
   26 The modifiable array variables are [cmd ::tkcon::COLOR] and
   27 [cmd ::tkcon::OPT].
   28 You can call
   29 
   30 [example_begin]
   31 tkcon set ::tkcon::COLOR
   32 [example_end]
   33 
   34 when the program is running to check its state.
   35 Here is an explanation of certain variables you
   36 might change or use:
   37 
   38 [list_begin definitions]
   39 
   40 [def [cmd ::tkcon::COLOR(bg)]]
   41 The background color for tkcon text widgets.
   42 Defaults to the operating system default (determined at startup).
   43 
   44 [def [cmd ::tkcon::COLOR(blink)]]
   45 The background color of the electric brace highlighting, if on.
   46 Defaults to yellow.
   47 
   48 [def [cmd ::tkcon::COLOR(cursor)]]
   49 The background color for the insertion cursor in tkcon.
   50 Defaults to black.
   51 
   52 [def [cmd ::tkcon::COLOR(disabled)]]
   53 The foreground color for disabled menu items.
   54 Defaults to dark grey.
   55 
   56 [def [cmd ::tkcon::COLOR(proc)]]
   57 The foreground color of a recognized proc, if command highlighting is on.
   58 Defaults to dark green.
   59 
   60 [def [cmd ::tkcon::COLOR(var)]]
   61 The background color of a recognized var, if command highlighting is on.
   62 Defaults to pink.
   63 
   64 [def [cmd ::tkcon::COLOR(prompt)]]
   65 The foreground color of the prompt as output in the console.
   66 Defaults to brown.
   67 
   68 [def [cmd ::tkcon::COLOR(stdin)]]
   69 The foreground color of the stdin for the console.
   70 Defaults to black.
   71 
   72 [def [cmd ::tkcon::COLOR(stdout)]]
   73 The foreground color of the stdout as output in the console.
   74 Defaults to blue.
   75 
   76 [def [cmd ::tkcon::COLOR(stderr)]]
   77 The foreground color of stderr as output in the console.
   78 Defaults to red.
   79 
   80 [def [cmd ::tkcon::OPT(autoload)]]
   81 Packages to automatically load into the slave interpreter (i.e. 'Tk').
   82 This is a list.
   83 Defaults to {} (none).
   84 
   85 [def [cmd ::tkcon::OPT(blinktime)]]
   86 The amount of time (in millisecs) that braced sections should blink for.
   87 Defaults to 500 (0.5 secs), must be at least 100.
   88 
   89 [def [cmd ::tkcon::OPT(blinkrange)]]
   90 Whether to blink the entire range for electric brace matching
   91 or to just blink the actual matching braces (respectively 1 or 0,
   92 defaults to 1).
   93 
   94 [def [cmd ::tkcon::OPT(buffer)]]
   95 The size of the console scroll buffer (in lines).
   96 Defaults to 512.
   97 
   98 [def [cmd ::tkcon::OPT(calcmode)]]
   99 Whether to allow expr commands to be run at the command line
  100 without prefixing them with expr (just a convenience).
  101 
  102 [def [cmd ::tkcon::OPT(cols)]]
  103 Number of columns for the console to start out with.
  104 Defaults to 80.
  105 
  106 [def [cmd ::tkcon::OPT(dead)]]
  107 What to do with dead connected interpreters.
  108 If dead is leave, TkCon automatically exits the dead interpreter.
  109 If dead is ignore then it remains attached waiting for the
  110 interpreter to reappear.
  111 Otherwise TkCon will prompt you.
  112 
  113 [def [cmd ::tkcon::OPT(exec)]]
  114 This corresponds to the [cmd -exec] tkcon option (see [cmd tkcon](1)).
  115 
  116 [def [cmd ::tkcon::OPT(font)]]
  117 Font to use for tkcon text widgets (also specified with [cmd -font] option).
  118 Defaults to the system default, or a fixed width equivalent.
  119 
  120 [def [cmd ::tkcon::OPT(gets)]]
  121 Controls whether tkcon will overload the gets command to work with tkcon.
  122 The valid values are: congets (the default), which will redirect
  123 stdin requests to the tkcon window; gets, which will pop up a dialog to
  124 get input; and {} (empty string) which tells tkcon not to overload gets.
  125 This value must be set at startup to alter tkcon's behavior.
  126 
  127 [def [cmd ::tkcon::OPT(history)]]
  128 The size of the history list to keep.
  129 Defaults to 48.
  130 
  131 [def [cmd ::tkcon::OPT(hoterrors)]]
  132 Whether hot errors are enabled or not.
  133 When enabled, errors that are returned to the console are marked
  134 with a link to the error info that will pop up in an minimal editor.
  135 This requires more memory because each error that occurs will
  136 maintain bindings for this feature, as long as the error
  137 is in the text widget.
  138 Defaults to on.
  139 
  140 [def [cmd ::tkcon::OPT(library)]]
  141 The path to any tcl library directories (these are appended
  142 to the [cmd auto_path] when the after the resource file is loaded in).
  143 
  144 [def [cmd ::tkcon::OPT(lightbrace)]]
  145 Whether to use the brace highlighting feature or not
  146 (respectively 1 or 0, defaults to 1).
  147 
  148 [def [cmd ::tkcon::OPT(lightcmd)]]
  149 Whether to use the command highlighting feature or not
  150 (respectively 1 or 0, defaults to 1).
  151 
  152 [def [cmd ::tkcon::OPT(maineval)]]
  153 A tcl script to execute in the main interpreter after the
  154 slave interpreter is created and the user interface is initialized.
  155 
  156 [def [cmd ::tkcon::OPT(maxlinelen)]]
  157 A number that specifies the limit of long result lines.
  158 True result is still captured in $_ (and 'puts $_' works).
  159 Defaults to 0 (unlimited).
  160 
  161 [def [cmd ::tkcon::OPT(maxmenu)]]
  162 A number that specifies the maximum number of packages to
  163 show vertically in the [arg Interp->Packages] menu before breaking
  164 into another column.
  165 Defaults to 15.
  166 
  167 [def [cmd ::tkcon::OPT(nontcl)]]
  168 For those who might be using non-Tcl based Tk attachments, set this to 1.
  169 It prevents TkCon from trying to evaluate its own Tcl
  170 code in an attached interpreter.
  171 Also see my notes for non-Tcl based Tk interpreters.
  172 
  173 [def [cmd ::tkcon::OPT(prompt1)]]
  174 Like [cmd tcl_prompt1], except it doesn't require you use [cmd puts].
  175 No equivalent for [cmd tcl_prompt2] is available (it's unnecessary IMHO).
  176 Defaults to {([lb]file tail [lb]pwd[rb][rb]) [lb]history nextid[rb] % }.
  177 
  178 [def [cmd ::tkcon::OPT(rows)]]
  179 Number of rows for the console to start out with.
  180 Defaults to 20.
  181 
  182 [def [cmd ::tkcon::OPT(scollypos)]]
  183 Y scrollbar position.
  184 Valid values are left or right.
  185 Defaults to right.
  186 
  187 [def [cmd ::tkcon::OPT(showmenu)]]
  188 Show the menubar on startup (1 or 0, defaults to 1).
  189 
  190 [def [cmd ::tkcon::OPT(showmultiple)]]
  191 Show multiple matches for path/proc/var name expansion (1 or 0,
  192 defaults to 1).
  193 
  194 [def [cmd ::tkcon::OPT(slaveeval)]]
  195 A tcl script to execute in each slave interpreter right after it's created.
  196 This allows the user to have user defined info always available in a slave.
  197 
  198 [para]
  199 Example:
  200 
  201 [example_begin]
  202 set ::tkcon::OPT(slaveeval) {
  203     proc foo args { puts $args }
  204     lappend auto_path .
  205 }
  206 [example_end]
  207 
  208 [def [cmd ::tkcon::OPT(slaveexit)]]
  209 Allows the prevention of exit in slaves from exitting the entire application.
  210 If it is equal to exit, exit will exit as usual, otherwise it will just close
  211 down that interpreter (and any children).
  212 Defaults to close.
  213 
  214 [def [cmd ::tkcon::OPT(subhistory)]]
  215 Allow history substitution to occur (0 or 1, defaults to 1).
  216 The history list is maintained in a single interpreter per TkCon console
  217 instance.
  218 Thus you have history which can range over a series of attached interpreters.
  219 
  220 [list_end]
  221 
  222 [section EXAMPLES]
  223 [para]
  224 An example TkCon resource file might look like:
  225 
  226 [example_begin]
  227 ######################################################
  228 ## My TkCon Resource File
  229 
  230 # Use a fixed default font
  231 #tkcon font fixed; # valid on unix
  232 #tkcon font systemfixed; # valid on win
  233 tkcon font Courier 12; # valid everywhere
  234 
  235 # Keep 50 commands in history
  236 set ::tkcon::OPT(history) 50
  237 
  238 # Use a pink prompt
  239 set ::tkcon::COLOR(prompt) pink
  240 ######################################################
  241 [example_end]
  242 
  243 [see_also [cmd tkcon](1)]
  244 [see_also [cmd dump](n) [cmd tkcon](n) [cmd idebug](n)]
  245 [see_also [cmd observe](n)]
  246 [keywords Tk console]
  247 
  248 [manpage_end]
  249