home *** CD-ROM | disk | FTP | other *** search
/ CD Actual 3 / CD ACTUAL 3.iso / linux / incoming / jstools-.6v3 / jstools- / jstools-tk3.6v3.0 / lib / jdoc / jmore.jdoc < prev    next >
Encoding:
Text File  |  1995-03-14  |  10.7 KB  |  94 lines

  1. {The jmore File Viewer
  2.  
  3. Introduction
  4. The jmore application is an X Windows version of more(1) - an application that lets you page through one or more specified files or standard input.  It is written in wish, an X Windows scripting language based on the Tk toolkit and the Tcl scripting library (all three by John Ousterhout of Sun Microsystems).
  5.  
  6. A preferences panel and a separate preferences application let you configure its appearance, and you can further customise its behaviour via a startup file written in Tcl.
  7.  
  8. The jmore application is essentially a wrapper around the j:more panel defined in the jmore.tcl library.  (This is responsible for some of its limitations.)
  9.  
  10. The jmore file viewer is distributed as part of the jstools package.
  11.  
  12. This help file describes jmore version 3.6/3.0.
  13.  
  14. Copyright and contact information is available in the jstools documentation.
  15.  
  16. Invocation
  17.     jmore [filename]...
  18. or
  19.     jmore -prefs
  20.  
  21. To view a file, type `jmore filename' at the Unix shell prompt, assuming jmore is in your path.  You'll get an error message if the file doesn't exist.
  22.  
  23. You can specify several files on the command line; each will be displayed in its own window.
  24.  
  25. If you don't specify any files on the command line, jmore will read its standard input until end¡of¡file, and then display it.  (Thus, jmore can be used at the end of a pipe, or specified as a pager for other applications.)
  26.  
  27. If you invoke jmore with the -prefs flag, then instead of displaying files jmore will present you with a preferences panel (described below) that lets you set preferences.  The preferences you choose will take effect the next time you use jmore.
  28.  
  29. Viewing the Text
  30. You can't edit the text displayed in a jmore window, but you can select it.
  31.  
  32. If it's longer than one screenful, you can scroll it with the scrollbar.  You can also scroll from the keyboard: pressing Space, Next or PageDown, or Control-v will scroll the text down, and pressing b, Prior or PageUp, or Escape-v will scroll the text up.
  33.  
  34. Using the Buttons
  35. At the bottom of each jmore window are four buttons: `Done', `Save', `Print', and `Find...'.
  36.  
  37. Done
  38. This button closes the window.  If it's the last (or only) jmore window, it also quits jmore.  The Done button is the default button, so just pressing Return will invoke it.
  39.  
  40. Save
  41. This button brings up a File Selector panel that prompts you for the name of a file to save the contents of the window to.
  42.  
  43. Print
  44. After asking for confirmation, this button prints the contents of the window (using the Unix lpr command) to the printer you have selected on the Global Preferences panel.  (See Preferences and Invocation on how to bring up the Global Preferences panel.)
  45.  
  46. Find...
  47. This button brings up a panel that lets you search for text in the window.  Note that the Find panel searches from the position of an invisible `insert point' in the text window.  This can be confusing.  If you can't find something you think should be there, try scrolling to the top of the window and clicking the mouse at the beginning of the text.
  48.  
  49. Preferences
  50. File Viewer Preferences...
  51. When you invoke the file viewer with the -prefs flag, it displays a preferences panel.  At the bottom of the panel are two buttons, `Save', which saves the current settings on the File Viewer Preferences panel and quits, and `Global Preferences', which brings up the jstools Global Preferences panel.  The Save button is the default button, so you can just press Return to invoke it.
  52.  
  53. The three radio buttons labelled `Don't wrap lines', `Wrap lines on character boundaries', and `Wrap lines at word boundaries' control how lines which are longer than the width of the window are displayed.  They should be fairly self¡explanatory.
  54.  
  55. The `Font:' field lets you choose what font is used to display the text you're viewing.  You can type in an X font specification, or click the `Choose...' button to select a font visually using the xfontsel(1X11) application.  (Use xfontsel's menus to choose a font based on its various attributes, such as size and weight, and click xfontsel's `Quit' button to enter the font you have chosen into the editor's `Font:' field.)  You can click the `Default' button to set the font field to `default', which means to use the X default font (using the X default specification `Tk*Font:'), or 12¡point Courier if there is no X default.  See the man page for the X server, often X(1X11), for more information about X font specifications and X defaults.
  56.  
  57. The `Width:' and `Height:' fields let you change the width (in columns) and height (in characters) of viewer windows.
  58.  
  59. File viewer preferences are stored in the file ~/.tk/jmore-defaults.  (Global preferences are saved in the file ~/.tk/defaults.)
  60.  
  61. Customising jmore
  62. jmore supports the standard jstools customisation mechanisms.  You should consult the document Customising jstools Applications as well as the description below.
  63.  
  64. The ~/.tk/jmorerc.tcl startup script
  65. The file ~/.tk/jmorerc.tcl can contain Tcl code to customise your file viewing environment.  At present, it isn't very useful, because the structure of the application makes it hard to customise the user interface.  I hope to add hooks in a future version to make it easier to customise jmore; for instance, to let you add buttons, or run filters on files before displaying them.
  66.  
  67. Sample files
  68. If jmore was installed normally at your site, the directory /usr/local/lib/tk/jmore/samples should contain some example files which you can copy, rename appropriately, and modify to your liking.  (You may also find it useful to look at the jmore script itself, and for information about Tcl syntax you should consult the various Tcl and Tk man pages.)
  69.  
  70. Evolution
  71. Feel free to report bugs (and feature requests) to me, <js@bu.edu>, and I will try to deal with them.  Also, feel free to fix bugs or add features on your own and let me know how you did it.
  72.  
  73. Bugs and Misfeatures
  74. * If there's a Find panel displayed when you close the last file viewer window, the application doesn't quit.
  75.  
  76. * The -prefs flag is a silly kludge.  There should be a `Prefs...' button or some such.
  77.  
  78. * The behaviour of the Find panel (searching from an invisible insert point) is confusing.
  79.  
  80. Future Directions
  81. * There should be more preferences, for such things as colours.
  82.  
  83. * There should be a -class or -mode command¡line option, so, for instance, copies of jmore being used as pagers for mail can be visually distinct from other invocations of jmore.
  84.  
  85. * A menu might be nice.
  86.  
  87. * I want to standardise bindings for non¡editable text widgets and put them in the bindings libraries in some fashion.
  88.  
  89. * I want to put in hooks that the user can redefine in ~/.tk/jmorerc.tcl for things like filtering files as they're read or adding buttons (which latter will depend on adding j:more:button to jmore.tcl).
  90.  
  91. * When reading from standard input, jmore should display data as it's received, rather than just showing it all at the end.  (I.e., it should do what tail -f does.)
  92.  
  93. * The Find panel should work differently; it should highlight all the found strings, and then let you jump back and forth among them.
  94. } {{{jdoc:xref:link {6.0 6.19 6.24 6.58 8.86 8.95 10.52 10.59 14.0 14.33 14.50 14.75 27.103 27.122 41.24 41.43 44.178 44.189 44.194 44.204 51.263 51.299 62.15 62.60 62.95 62.127 89.192 89.201}} {jdoc:xref:manpage {4.49 4.53 55.198 55.206 55.232 55.240 55.334 55.342 55.673 55.674}} {jdoc:anchor:anchorname {3.0 4.0 16.0 17.0 29.0 30.0 34.0 35.0 49.0 51.0 61.0 62.0 70.0 71.0}} {richtext:font:roman {2.0 3.0 4.0 4.4 4.9 4.49 4.53 4.166 4.170 8.4 8.9 8.58 8.64 8.86 8.95 10.4 10.9 10.52 10.59 12.25 12.30 14.54 14.61 16.0 17.7 17.8 17.16 19.0 19.13 21.22 21.36 21.73 21.78 25.52 25.57 25.135 25.140 27.14 27.19 27.29 27.35 27.75 27.80 27.239 27.244 29.0 30.0 30.39 30.44 32.122 32.127 32.129 32.133 32.137 32.145 32.150 32.159 32.200 32.201 32.203 32.208 32.212 32.218 32.223 32.231 34.0 35.0 35.22 35.27 37.0 38.0 38.59 38.64 38.87 38.92 38.151 38.157 40.0 41.0 43.0 44.0 44.93 44.96 44.178 44.189 44.194 44.204 46.0 47.0 49.0 51.0 51.41 51.47 51.267 51.274 51.363 51.369 55.198 55.206 55.232 55.240 55.334 55.342 55.489 55.496 55.573 55.581 55.673 55.674 59.47 59.67 59.112 59.126 61.0 62.5 62.28 62.35 62.95 62.127 64.0 65.0 65.9 65.26 65.203 65.204 65.287 65.292 67.0 68.0 68.3 68.8 68.60 68.91 68.240 68.245 70.0 71.0 71.55 71.66 73.0 74.0 76.6 76.12 80.0 81.0 83.20 83.26 83.30 83.35 83.85 83.90 83.172 83.177 89.55 89.72 89.175 89.188 89.192 89.201 91.36 91.41 91.150 91.157 94.0}} {richtext:font:italic {17.8 17.16 21.28 21.36}} {richtext:font:bold {8.86 8.95 10.52 10.59 14.54 14.61 32.122 32.127 32.129 32.133 32.137 32.145 32.150 32.159 32.200 32.201 32.203 32.208 32.212 32.218 32.223 32.231 38.151 38.157 51.267 51.274 51.363 51.369 59.47 59.67 59.112 59.126 62.28 62.35 65.9 65.26 65.203 65.204 89.55 89.72 89.192 89.201}} {richtext:font:bolditalic {44.178 44.189 44.194 44.204 62.95 62.127}} {richtext:font:typewriter {4.4 4.9 4.49 4.53 4.166 4.170 8.4 8.9 8.58 8.64 10.4 10.9 12.25 12.30 17.0 17.7 19.0 19.13 21.22 21.28 21.73 21.78 25.52 25.57 25.135 25.140 27.14 27.19 27.29 27.35 27.75 27.80 27.239 27.244 30.39 30.44 35.22 35.27 38.59 38.64 38.87 38.92 44.93 44.96 51.41 51.47 55.198 55.206 55.232 55.240 55.334 55.342 55.489 55.496 55.573 55.581 55.673 55.674 62.0 62.5 65.287 65.292 68.3 68.8 68.60 68.91 68.240 68.245 71.55 71.66 76.6 76.12 83.20 83.26 83.30 83.35 83.85 83.90 83.172 83.177 89.175 89.188 91.36 91.41 91.150 91.157}} {richtext:font:heading0 {1.0 2.0}} {richtext:font:heading1 {3.0 4.0 16.0 17.0 29.0 30.0 34.0 35.0 49.0 50.0 61.0 62.0 70.0 71.0}} {richtext:font:heading2 {37.0 38.0 40.0 41.0 43.0 44.0 46.0 47.0 50.0 51.0 64.0 65.0 67.0 68.0 73.0 74.0 80.0 81.0}} {jdoc:manpage:more {4.49 4.53}} {jdoc:topic:jmore.tcl {8.86 8.95 89.192 89.201}} {jdoc:section:Preferences {44.178 44.189}} {jdoc:section:Invocation {44.194 44.204}} {jhelp:manpage:xfontsel {55.198 55.206 55.232 55.240 55.334 55.342}} {jdoc:topic:jstools {10.52 10.59}} {jdoc:manpage:X {55.673 55.674}} {jdoc:link:jmore.tcl.jdoc {8.86 8.95 89.192 89.201}} {jdoc:link:jstools.jdoc {10.52 10.59 14.50 14.75}} {jdoc:anchorname:Preferences {49.0 50.0}} {jdoc:anchorname:File_Viewer_Preferences {50.0 51.0}} {jdoc:link:#File_Viewer_Preferences {27.103 27.122}} {jdoc:link:jprefs.jdoc {6.24 6.58}} {jdoc:link:#Preferences {44.178 44.189}} {jdoc:link:#Invocation {44.194 44.204}} {jdoc:anchorname:Invocation {16.0 17.0}} {jdoc:link:panels/fileselector.jdoc {41.24 41.43}} {jdoc:link:panels/prefs.jdoc {6.0 6.19 51.263 51.299}} {jdoc:anchorname:Introduction {3.0 4.0}} {jdoc:anchorname:Viewing_the_Text {29.0 30.0}} {jdoc:anchorname:Using_the_Buttons {34.0 35.0}} {jdoc:anchorname:Customising_jmore {61.0 62.0}} {jdoc:anchorname:Evolution {70.0 71.0}} {jdoc:link:jstools/customisation.jdoc {62.15 62.60 62.95 62.127}} {jdoc:link:jstools.jdoc#Credits_and_Copyright {14.0 14.33}}} {{abbrevstart 62.127} {del_from 67.0} {abbrevend 62.127} {insert 12.46} {del_to 68.31} {anchor 12.46} {current 1.0}}}