___________________ ## ### ___________________ ___________________ ## ## ___________________ ___________________ ## ## ## #### #### ## ## ___________________ ___________________ ## ## ## ## ## ## ## ## ## ___________________ ___________________ ## ## ## ## ## ## ## #### ___________________ ___________________ ## ## ## ## ## ## ## ## ## ___________________ ___________________ ### ## ###### #### #### ### ## ___________________ ________________________________ User Manual ________________________________ CONTENTS OF USER MANUAL: 1:Intro 2:Page Size 3:Line Length 4:Line Numbering 5:Navigation 6:Search 7:Command Line Syntax 8:Main uLook Commands 9:Search Syntax 10:About uLook ______________________________________________________________________________ INTRO 1 ----------------------------------------------------------------------------- 'uLook' is a text file viewer which is evoked from the command line. It is based on the 'more' command found in both DOS and Unix systems but offers additional functionality which allows the user the freedom to navigate through the selected text file in a variety of different ways. ______________________________________________________________________________ PAGE SIZE 2 ----------------------------------------------------------------------------- 'uLook' displays text files one page (screen) at a time. The page size defaults to 20 lines-per-screen but the user can re-set this within the range 1..40, using the -Lnum argument. ______________________________________________________________________________ LINE LENGTH 3 ----------------------------------------------------------------------------- If the terminal supports wrapping, lines longer than 80 characters will be wrapped. The -L argument needs to take account of this. For example if all the lines in the file are 100 characters long each text line will take two lines on the screen. The -L parameter will need to be set at 11 or 12 (on a standard screen) to account for this. If the terminal does not support wrapping the lines will disappear off the right hand side of the screen. Under X Windows the terminal screen can be extended both vertically and horizontally. Use this facility to eliminate the wrapping problem or to view screens of more than 20 lines. If using a text-only terminal specify smaller line counts. ______________________________________________________________________________ LINE NUMBERING 4 ----------------------------------------------------------------------------- The file can be displayed with line numbers in the leftmost column. A copy of the line-numbered output can be saved to a new file (with .lok extension). Note: files containing 10000+ lines will only be numbered up to line 9999. ______________________________________________________________________________ NAVIGATION 5 ----------------------------------------------------------------------------- Once inside the application the user is able to scroll forwards or backwards through the pages, to jump from one page to another, to skip pages or to view different sections of a file at the same time. Help on the different options can be obtained at any time by typing '?' at the 'Next:' prompt. The search environment can be accessed by typing '-S' or '-SEARCH' at the prompt. ______________________________________________________________________________ WORD/PHRASE SEARCH 6 ----------------------------------------------------------------------------- By entering the 'Search>' environment the user is able to search for a particular word or phrase. Search strings are case-sensitive by default but can be forced to ignore case. Search results can be displayed as full pages, with occurrences indicated by line numbers, or as a list of line-numbers only. Any search result can be saved to a file (the file name will consist of the first 8 characters of the search string). ______________________________________________________________________________ COMMAND LINE SYNTAX 7 ----------------------------------------------------------------------------- ulook [path/]filename [-Lnum] [-N] [-F] ulook [-HELP | -MAN] The optional arguments can be in upper or lower case. The DOS-style '/' switch is also supported, (e.g. /L15) [path/]filename name of file to be viewed. -Lnum specify number of Lines per screen, range 1..40, default=20 -N display file with line Numbers -F save line-numbered copy of input File (must also specify -N) -HELP display main help screen, (context-sensitive help can be accessed at any time by typing '?' at the prompt) -MAN display the user-manual (this document) ______________________________________________________________________________ MAIN PROGRAM (Next:) COMMANDS 8 ----------------------------------------------------------------------------- to scroll through screens # to reverse direction of scroll 1..40 to jump to specified screen -s|-search to enter Search environment [then '?' for Search Help] ? to display this list of commands 0(zero)|q|quit to Quit/Exit ______________________________________________________________________________ SEARCH (Search>) SYNTAX 9 ----------------------------------------------------------------------------- [-f|/f] [-i|/i] [-n|/n] [-a|/a] "Word or phrase" "Word or phrase" can be up to 80 characters and can contain any valid (printable) ANSI character except #34 ["] Optional arguments can be before or after "Word or phrase" in upper or lower case: -f|/f save output to text file -i|/i ignore case -b|/b brief: numbered output only; do not display actual screens -a|/a sound an audible beep each time a match is successful Additional Commands: !|r repeat last search; additional arguments can be appended to '!|r', but NOT additional text ? display Search Help 0|q|quit quit Search & return to 'Next:' prompt ______________________________________________________________________________ ABOUT 'uLook' 10 ----------------------------------------------------------------------------- 'uLook' was originally written for a DOS system. It came about as a result of my frustration with the limitations of the 'more' command. I wanted a simple viewer for examining source code files, one that I could move about in freely and view any section of the file in any order. The search facility was added later when I started using it for larger source code files; I wanted a quick way of hunting for (and counting) keywords, variable names, etc. Little adaptation was needed to produce this Unix version. The 'u' was added to avoid conflict with another Unix program. It now recognises long file names and has finally got a User Manual. Otherwise it is the same program. 'uLook' was written in Ada 95. _____________________________________________________________________________ uLOOK [v1.35.u] 28 February 1997 contact: mayert@sbu.ac.uk ______________________________________________________________________________ END