Changes between Initial Version and Version 1 of HemlockUser/SystemInterface


Ignore:
Timestamp:
11/05/07 18:03:02 (7 years ago)
Author:
rme
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • HemlockUser/SystemInterface

    v1 v1  
     1[[PageOutline]] 
     2 
     3= 12 System Interface = 
     4 
     5Hemlock provides a number of commands that access operating system 
     6resources such as the filesystem and print servers. These commands 
     7offer an alternative to leaving the editor and using the normal 
     8operating system command language (such as the Unix shell), but they 
     9are implementation dependent. Therefore, they might not even exist in 
     10some implementations. 
     11 
     12== 12.1 File Utility Commands == 
     13 
     14This section describes some general file operation commands and quick 
     15directory commands. 
     16 
     17See section 6.1 for a description Hemlock's directory editing 
     18mechanism, Dired mode. 
     19 
     20Copy File                [Command] 
     21 
     22This command copies a file, allowing one wildcard in the filename. It 
     23prompts for source and destination specifications. 
     24 
     25If these are both directories, then the copying process is recursive 
     26on the source, and if the destination is in the subdirectory structure 
     27of the source, the recursion excludes this portion of the directory 
     28tree. Use dir-spec-1/* to copy only the files in a source directory 
     29without recursively descending into subdirectories. 
     30 
     31If the destination specification is a directory, and the source is a 
     32file, then it is copied into the destination with the same filename. 
     33 
     34The copying process copies files maintaining the source's write date. 
     35 
     36See the description of Dired Copy File Confirm, page 6.1.5, for 
     37controlling user interaction when the destination exists. 
     38 
     39 
     40 
     41Rename File              [Command] 
     42 
     43This command renames a file, allowing one wildcard in the filename. It 
     44prompts for source and destination specifications. 
     45 
     46If the destination is a directory, then the renaming process moves 
     47file(s) indicated by the source into the directory with their original 
     48filenames. 
     49 
     50For Unix-based implementations, if you want to rename a directory, do 
     51not specify the trailing slash in the source specification. 
     52 
     53 
     54 
     55Delete File              [Command] 
     56 
     57This command prompts for the name of a file and deletes it. 
     58 
     59 
     60 
     61Directory       (bound to C-x C-d)       [Command] 
     62 
     63Verbose Directory       (bound to C-x C-D)       [Command] 
     64 
     65These commands prompt for a pathname (which may contain wildcards), 
     66and display a directory listing in a pop-up window. If a prefix 
     67argument is supplied, then normally hidden files such as Unix 
     68dot-files will also be displayed. Directory uses a compact, 
     69multiple-column format; Verbose Directory displays one file on a line, 
     70with information about protection, size, etc. 
     71 
     72 
     73 
     74== 12.2 Printing == 
     75 
     76Print Region             [Command] 
     77 
     78Print Buffer             [Command] 
     79 
     80Print File               [Command] 
     81 
     82Print Region and Print Buffer print the contents of the current region 
     83and the current buffer, respectively. Print File prompts for a the 
     84name of a file and prints that file. Any error messages will be 
     85displayed in the echo area. 
     86 
     87 
     88 
     89Print Utility   (initial value "/usr/cs/bin/lpr")        [Variable] 
     90 
     91Print Utility Switches          (initial value ())       [Variable] 
     92 
     93Print Utility is the program the print commands use to send files to 
     94the printer. The program should act like lpr: if a filename is given 
     95as an argument, it should print that file, and if no name appears, 
     96standard input should be assumed. Print Utility Switches is a list of 
     97strings specifying the options to pass to the program. 
     98 
     99 
     100 
     101== 12.3 Scribe == 
     102 
     103Scribe Buffer File               [Command] 
     104 
     105Scribe Buffer File Confirm      (initial value t)        [Variable] 
     106 
     107Scribe File              [Command] 
     108 
     109Scribe Buffer File invokes Scribe Utility on the file associated with 
     110the current buffer. That process's default directory is the directory 
     111of the file. The process sends its output to the Scribe Warnings 
     112buffer. Before doing anything, this asks the user to confirm saving 
     113and formatting the file. This prompting can be inhibited with "Scribe 
     114Buffer File Confirm". 
     115 
     116Scribe File invokes Scribe Utility on a file supplied by the user in 
     117the same manner as describe above. 
     118 
     119 
     120 
     121Scribe Utility          (initial value "/usr/misc/bin/scribe")   [Variable] 
     122 
     123Scribe Utility Switches         (initial value )         [Variable] 
     124 
     125Scribe Utility is the program the Scribe commands use to compile the 
     126text formatting. Scribe Utility Switches is a list of strings whose 
     127contents would be contiguous characters, other than space, had the 
     128user invoked this program on a command line outside of Hemlock. Do not 
     129include the name of the file to compile in this variable; the Scribe 
     130commands supply this. 
     131 
     132 
     133 
     134Select Scribe Warnings          (bound to Scribe: C-M-C)         [Command] 
     135 
     136This command makes the Scribe Warnings buffer current if it exists. 
     137 
     138 
     139 
     140== 12.4 Miscellaneous == 
     141 
     142Manual Page              [Command] 
     143 
     144This command displays a Unix manual page in a buffer which is in View 
     145mode. When given an argument, this puts the manual page in a pop-up 
     146display. 
     147 
     148 
     149 
     150Unix Filter Region               [Command] 
     151 
     152This command prompts for a UNIX program and then passes the current 
     153region to the program as standard input. The standard output from the 
     154program is used to replace the region. This command is undoable. 
     155