home *** CD-ROM | disk | FTP | other *** search
/ The World of Computer Software / World_Of_Computer_Software-02-387-Vol-3of3.iso / 3 / 3dired11.zip / READ.ME < prev    next >
Text File  |  1992-08-23  |  20KB  |  499 lines
  1.  
  2.  
  3.  -\|/-  Dired [1.1] for MicroEMACS === 1992 (c) J. E. Hetrick      
  4.  
  5.  __________________________________________________________________
  6.  
  7.  
  8.  This is a package of Dired.cmd files for use with MicroEMACS
  9.  3.11. Dired is a GNUEmacs function which allows you to load
  10.  a directory listing into a buffer and then manipulate the 
  11.  files by keystroke and mouse actions. It's handy for cleaning 
  12.  up directories, compressing, and uncompressing, and archiving.
  13.  In some sense it is a menu-like interface to your directory tree.
  14.  Note too that some functions here are modeled after Sebastian
  15.  Kramer's, now classic, "Tree Dired" extension of GNU Dired.
  16.  
  17.  The package contains 3 files:
  18.  
  19.      dosdired.cmd  --- for use with MicroEMACS under DOS
  20.      unxdired.cmd  --- for MicroEMACS under Unix
  21.      read.me       --- this file
  22.  
  23.  Most functions are the same in each version, however I found that
  24.  the function key interface was faster in the DOS version, ie entering
  25.  commands via the Shifted F-keys. Whereas, there is no uniform behavior
  26.  of these keys on Unix systems, so the commands are entered via letter
  27.  keys, like in GNUEmacs Dired.
  28.  
  29.  Since the functioning of the two versions is sufficiently different
  30.  I won't try to outline them here, but have included commented 
  31.  documentation in the header of each version. You can chop this out 
  32.  and make a manual page if you like. The function section of each 
  33.  is reproduced here.
  34.  
  35.  A couple points to note:
  36.  
  37.       ************************************************************      
  38.       As this program has the capability to DELETE YOUR FILES! 
  39.       please put some test files in a subdirectory and try it 
  40.       out on them. After you're convinced of its integrity, put it 
  41.       herever your .cmd files live and fire at will. 
  42.       ************************************************************
  43.  
  44.    * DOS * version:
  45.    ================
  46.  
  47.       The DOS version relies on a function called "mv" to 
  48.       move files from one directory to another. There are several
  49.       ShareWare and Public Domain versions which do this. Just
  50.       check the archive where you got jdired11.zip and see what 
  51.       they have. Please familiarize yourself with the functioning
  52.       of "mv" so that you will be sure what action is taking place
  53.       when you "move" a file with S-F3. Note too, that the name of
  54.       the move function must be set in the statement:
  55.           set %mvfunc "mv ".
  56.  
  57.       The archiving functions depend on PKzip and PKUnZip being in
  58.       your path. This can be easily rewritten if you prefer another
  59.       archiver (but you have to do it :-)
  60.  
  61.       In the section of code which handles command processing,
  62.       D-process, I've left in the Unix style letter command 
  63.       processing in case you prefer to switch back. If you use
  64.       MicroEMACS both under DOS and Unix, it's much nicer to 
  65.       have the same functionality. Just follow the directions in
  66.       the source if you want to change over to letters.
  67.  
  68.       A code page for DOS Dired is included in the header of
  69.       that version.
  70.  
  71.    DOS Functions:
  72.    =============
  73. """"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
  74. ;  Movement:    =   Usual: Up, Down, PgUp, PgDn, etc., and left mouse 
  75. ;                          button
  76. ;
  77. ;  <ENTER>      =   Load File   (on files)
  78. ;  or right     =   Load Subdir into Dired window (on subdirs)
  79. ;  mouse button     (with mouse hit the left button first to move the
  80. ;                    point to the current line, then click the right one)
  81. ;
  82. ;  C-<ENTER>    =   Split screen, load File/Subdir in second window
  83. ;
  84. ;  C-x C-f      =   Open new file: A single name gets the currently 
  85. ;                   viewed directory prepended. If the entered name 
  86. ;                   contains directory names, ie. has a "\" in it, 
  87. ;                   it is opened as is.)
  88. ;
  89. ;  C-x e        =   Execute File, works on some cmd files, like CAL1.CMD
  90. ;
  91. ;  C-c          =   Exit the Dired command processor. This just leaves
  92. ;                   you in the Directory listing as an ordinary file.
  93. ;
  94. ;    When entering filenames, for copy, move, etc., a single name gets
  95. ;    the currently viewed diredctory prepended. Names which contain "\"
  96. ;    are taken as is. Names ending in ":", ie. "A:" get a "\" postfixed.
  97. ;    Below,  --- is the action on a single file,
  98. ;            -*- is the action if files are marked.
  99. ;
  100. ;  S-F1   = Copy     --- you are prompted for a name/destination.
  101. ;                    -*- prompt for dest; copy all marked files
  102. ;
  103. ;  S-F2   = Delete   --- delete file. (you're prompted)
  104. ;                    -*- or all marked files. (prompted)
  105. ;                        >>>[prompting can be turned off for the brave]
  106. ;
  107. ;  S-F3   = Move     --- you are prompted for a destination.
  108. ;                    -*- prompt for dest; move all marked files
  109. ;                        (exact behavior depends on your "mv" function)
  110. ;
  111. ;  S-F4   = Rename   --- rename file
  112. ;
  113. ;  S-F5   = Mark     --- Mark file with %markstr ( * ) and move to next 
  114. ;                        line.
  115. ;
  116. ;  S-F6   = Un-Mark  --- Unmarks file.
  117. ;
  118. ;  S-F7   = Revert   --- Updates Dired buffer by re-reading
  119. ;                        directory from disk.
  120. ;
  121. ;  S-F8   = Make Subdir --- Make a new subdirectory
  122. ;
  123. ;  S-F9   = PK-Zip   ---  PKzips file.
  124. ;                    -*-  PKzips marked files into one zipfile.
  125. ;               file.zip  If pressed on an file ending in .ZIP,
  126. ;                           ie. trying to zip a zipped file,
  127. ;                           invokes PKzip -v, to view contents
  128. ;                           of file in another window.
  129. ;
  130. ;  S-F10  = PK-UnZip --- Un-zip file
  131.  """"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
  132.  
  133.  
  134.    * Unix * version:
  135.    =================
  136.  
  137.       The Unix version has a new "META"-type key. To enter 
  138.       commands such as C-x x (^XX) to change to a new buffer, you
  139.       first type "q", which prompts you for a "Command Sequence".
  140.       You then type whatever set of control characters you like
  141.       and Dired will process them (as best it can).
  142.  
  143.    Unix Functions:
  144.    ==============
  145. """""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
  146. ; Movement:
  147. ;
  148. ;      arrow keys: up and down  (seem to work for me)
  149. ;            P, N: up, down respectively
  150. ;            k, j: up, down respectively
  151. ;    q-PgUpKey, V: Page-up
  152. ;    q-PgDnKey, B: Page-down
  153. ;
  154. ;   A note about movement keys: the V and B above are delivered on some
  155. ;   machines as the *key* entered when hitting PgUp and PgDn. The
  156. ;   *cmd* is still (previous/next-page). Hence, your PgUp/Dn keys
  157. ;   may work just as keys, or you may have to prefix them with the
  158. ;   Dired-META "q" ie. q-PgUp... Failing that you can just enter "V"
  159. ;   or "B". The same applies to the arrow keys. Mine seem to work with
  160. ;   P and N, however k and j (like vi) are supplied in case yours don't.
  161. ;
  162. ;  (If you feel like recompiling, Richard Meitzler, Stratus Computer, 
  163. ;   Marlboro, MA, [rgm@hw.stratus.com] has had some success fixing 
  164. ;   unix.c in the memacs source to interpret the Sun/Sparc function 
  165. ;   keys.)
  166. ;
  167. ; Commands:
  168. ;
  169. ;   f --- load file/directory into current window
  170. ;
  171. ;   o --- load file/directory into another window
  172. ;
  173. ;  m,d -- mark file   (with %markstr)
  174. ;
  175. ;   u --- unmark file
  176. ;
  177. ;   c --- copy (marked) file(s)
  178. ;
  179. ;   r --- rename or move (marked) file(s)
  180. ;
  181. ;   x --- delete (marked) file(s)  [you're prompted; prompting can 
  182. ;                                   be turned off]
  183. ;
  184. ;   C --- compress ...
  185. ;
  186. ;   U --- uncompress ...
  187. ;
  188. ;   e --- extract tar file
  189. ;
  190. ;   t --- on a .tar archive, view contents in other window
  191. ;     --- or tar (marrked) file(s) into an archive
  192. ;            (must be viewing directory from which MicroEMACS
  193. ;             was invoked, ie. default directory at startup
  194. ;             so that files in tar file are portable---with no paths)
  195. ;
  196. ;   a --- execute file (useful for .cmd files; doesn't always work)
  197. ;
  198. ;   z --- leave dired processor (Dired-buffer becomes like any other)
  199. ;
  200. ;   Note that file or directory inputs to Dired are globbed
  201. ;   so that ~/filename is expanded using you $HOME variable
  202. ;   (only ~/ is expanded though).
  203. ;
  204. ;   Filenames and directories entered for copy, move, etc., are 
  205. ;   processed as follows: a single name gets the currently viewed 
  206. ;   directory prepended to it. If the filename/dir is entered with 
  207. ;   "/"'s in it, it's assumed that it represents a full pathname 
  208. ;   and left alone. ".." is a valid directory and will be expanded 
  209. ;   relative to the viewed directory.
  210. ;
  211. ;   C-x C-f (find-file) while in a some directory, opens a (new) file 
  212. ;                       in that directory.
  213. """"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
  214.    * Other Operating Systems *
  215.  
  216.       I haven't done any work with other systems than DOS and
  217.       Unix on a Sparc, Sun 3, and an RISC 6000. Dired should 
  218.       work fine though with perhaps a small bit of modification.
  219.       If you do this please write me about it, so I can credit
  220.       you and add your changes to new versions.
  221.  
  222.  
  223.  
  224.    PLEASE REPORT BUGS! (or delights). These projects work because
  225.    of a worldwide network of users who contribute their ideas and
  226.    time. If something goes wrong, please let me know so I can fix it.
  227.    On the other hand if you find you like this little piece of code,
  228.    don't hesitate to drop me a note saying so; it'll make my day a 
  229.    bit more pleasant.
  230.  
  231.    Thanks very much to Richard Meitzler for the 4DOS fix and for
  232.    beta testing this 1.1 version.
  233.  
  234.    That's about it. The above notes are also mentioned in the 
  235.    headers of each dired file.
  236.  
  237.  
  238.    Enjoy your time,
  239.  
  240.          Jim
  241.    
  242. ==============================================================
  243. James E. Hetrick            Institute for Theoretical Physics
  244. hetrick@phys.uva.nl                     -\|/-
  245.  
  246. University of Amsterdam
  247. Valckenierstraat 65, 1018 XE Amsterdam
  248. Telephone: +31 20 525 5663 Fax: +31 20 525 5788
  249. ===============================================================
  250.  
  251.  
  252.  -\|/-  Dired [1.1] for MicroEMACS === 1992 (c) J. E. Hetrick      
  253.  
  254.  __________________________________________________________________
  255.  
  256.  
  257.  This is a package of Dired.cmd files for use with MicroEMACS
  258.  3.11. Dired is a GNUEmacs function which allows you to load
  259.  a directory listing into a buffer and then manipulate the 
  260.  files by keystroke and mouse actions. It's handy for cleaning 
  261.  up directories, compressing, and uncompressing, and archiving.
  262.  In some sense it is a menu-like interface to your directory tree.
  263.  Note too that some functions here are modeled after Sebastian
  264.  Kramer's, now classic, "Tree Dired" extension of GNU Dired.
  265.  
  266.  The package contains 3 files:
  267.  
  268.      dosdired.cmd  --- for use with MicroEMACS under DOS
  269.      unxdired.cmd  --- for MicroEMACS under Unix
  270.      read.me       --- this file
  271.  
  272.  Most functions are the same in each version, however I found that
  273.  the function key interface was faster in the DOS version, ie entering
  274.  commands via the Shifted F-keys. Whereas, there is no uniform behavior
  275.  of these keys on Unix systems, so the commands are entered via letter
  276.  keys, like in GNUEmacs Dired.
  277.  
  278.  Since the functioning of the two versions is sufficiently different
  279.  I won't try to outline them here, but have included commented 
  280.  documentation in the header of each version. You can chop this out 
  281.  and make a manual page if you like. The function section of each 
  282.  is reproduced here.
  283.  
  284.  A couple points to note:
  285.  
  286.       ************************************************************      
  287.       As this program has the capability to DELETE YOUR FILES! 
  288.       please put some test files in a subdirectory and try it 
  289.       out on them. After you're convinced of its integrity, put it 
  290.       herever your .cmd files live and fire at will. 
  291.       ************************************************************
  292.  
  293.    * DOS * version:
  294.    ================
  295.  
  296.       The DOS version relies on a function called "mv" to 
  297.       move files from one directory to another. There are several
  298.       ShareWare and Public Domain versions which do this. Just
  299.       check the archive where you got jdired11.zip and see what 
  300.       they have. Please familiarize yourself with the functioning
  301.       of "mv" so that you will be sure what action is taking place
  302.       when you "move" a file with S-F3. Note too, that the name of
  303.       the move function must be set in the statement:
  304.           set %mvfunc "mv ".
  305.  
  306.       The archiving functions depend on PKzip and PKUnZip being in
  307.       your path. This can be easily rewritten if you prefer another
  308.       archiver (but you have to do it :-)
  309.  
  310.       In the section of code which handles command processing,
  311.       D-process, I've left in the Unix style letter command 
  312.       processing in case you prefer to switch back. If you use
  313.       MicroEMACS both under DOS and Unix, it's much nicer to 
  314.       have the same functionality. Just follow the directions in
  315.       the source if you want to change over to letters.
  316.  
  317.       A code page for DOS Dired is included in the header of
  318.       that version.
  319.  
  320.    DOS Functions:
  321.    =============
  322. """"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
  323. ;  Movement:    =   Usual: Up, Down, PgUp, PgDn, etc., and left mouse 
  324. ;                          button
  325. ;
  326. ;  <ENTER>      =   Load File   (on files)
  327. ;  or right     =   Load Subdir into Dired window (on subdirs)
  328. ;  mouse button     (with mouse hit the left button first to move the
  329. ;                    point to the current line, then click the right one)
  330. ;
  331. ;  C-<ENTER>    =   Split screen, load File/Subdir in second window
  332. ;
  333. ;  C-x C-f      =   Open new file: A single name gets the currently 
  334. ;                   viewed directory prepended. If the entered name 
  335. ;                   contains directory names, ie. has a "\" in it, 
  336. ;                   it is opened as is.)
  337. ;
  338. ;  C-x e        =   Execute File, works on some cmd files, like CAL1.CMD
  339. ;
  340. ;  C-c          =   Exit the Dired command processor. This just leaves
  341. ;                   you in the Directory listing as an ordinary file.
  342. ;
  343. ;    When entering filenames, for copy, move, etc., a single name gets
  344. ;    the currently viewed diredctory prepended. Names which contain "\"
  345. ;    are taken as is. Names ending in ":", ie. "A:" get a "\" postfixed.
  346. ;    Below,  --- is the action on a single file,
  347. ;            -*- is the action if files are marked.
  348. ;
  349. ;  S-F1   = Copy     --- you are prompted for a name/destination.
  350. ;                    -*- prompt for dest; copy all marked files
  351. ;
  352. ;  S-F2   = Delete   --- delete file. (you're prompted)
  353. ;                    -*- or all marked files. (prompted)
  354. ;                        >>>[prompting can be turned off for the brave]
  355. ;
  356. ;  S-F3   = Move     --- you are prompted for a destination.
  357. ;                    -*- prompt for dest; move all marked files
  358. ;                        (exact behavior depends on your "mv" function)
  359. ;
  360. ;  S-F4   = Rename   --- rename file
  361. ;
  362. ;  S-F5   = Mark     --- Mark file with %markstr ( * ) and move to next 
  363. ;                        line.
  364. ;
  365. ;  S-F6   = Un-Mark  --- Unmarks file.
  366. ;
  367. ;  S-F7   = Revert   --- Updates Dired buffer by re-reading
  368. ;                        directory from disk.
  369. ;
  370. ;  S-F8   = Make Subdir --- Make a new subdirectory
  371. ;
  372. ;  S-F9   = PK-Zip   ---  PKzips file.
  373. ;                    -*-  PKzips marked files into one zipfile.
  374. ;               file.zip  If pressed on an file ending in .ZIP,
  375. ;                           ie. trying to zip a zipped file,
  376. ;                           invokes PKzip -v, to view contents
  377. ;                           of file in another window.
  378. ;
  379. ;  S-F10  = PK-UnZip --- Un-zip file
  380.  """"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
  381.  
  382.  
  383.    * Unix * version:
  384.    =================
  385.  
  386.       The Unix version has a new "META"-type key. To enter 
  387.       commands such as C-x x (^XX) to change to a new buffer, you
  388.       first type "q", which prompts you for a "Command Sequence".
  389.       You then type whatever set of control characters you like
  390.       and Dired will process them (as best it can).
  391.  
  392.    Unix Functions:
  393.    ==============
  394. """""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
  395. ; Movement:
  396. ;
  397. ;      arrow keys: up and down  (seem to work for me)
  398. ;            P, N: up, down respectively
  399. ;            k, j: up, down respectively
  400. ;    q-PgUpKey, V: Page-up
  401. ;    q-PgDnKey, B: Page-down
  402. ;
  403. ;   A note about movement keys: the V and B above are delivered on some
  404. ;   machines as the *key* entered when hitting PgUp and PgDn. The
  405. ;   *cmd* is still (previous/next-page). Hence, your PgUp/Dn keys
  406. ;   may work just as keys, or you may have to prefix them with the
  407. ;   Dired-META "q" ie. q-PgUp... Failing that you can just enter "V"
  408. ;   or "B". The same applies to the arrow keys. Mine seem to work with
  409. ;   P and N, however k and j (like vi) are supplied in case yours don't.
  410. ;
  411. ;  (If you feel like recompiling, Richard Meitzler, Stratus Computer, 
  412. ;   Marlboro, MA, [rgm@hw.stratus.com] has had some success fixing 
  413. ;   unix.c in the memacs source to interpret the Sun/Sparc function 
  414. ;   keys.)
  415. ;
  416. ; Commands:
  417. ;
  418. ;   f --- load file/directory into current window
  419. ;
  420. ;   o --- load file/directory into another window
  421. ;
  422. ;  m,d -- mark file   (with %markstr)
  423. ;
  424. ;   u --- unmark file
  425. ;
  426. ;   c --- copy (marked) file(s)
  427. ;
  428. ;   r --- rename or move (marked) file(s)
  429. ;
  430. ;   x --- delete (marked) file(s)  [you're prompted; prompting can 
  431. ;                                   be turned off]
  432. ;
  433. ;   C --- compress ...
  434. ;
  435. ;   U --- uncompress ...
  436. ;
  437. ;   e --- extract tar file
  438. ;
  439. ;   t --- on a .tar archive, view contents in other window
  440. ;     --- or tar (marrked) file(s) into an archive
  441. ;            (must be viewing directory from which MicroEMACS
  442. ;             was invoked, ie. default directory at startup
  443. ;             so that files in tar file are portable---with no paths)
  444. ;
  445. ;   a --- execute file (useful for .cmd files; doesn't always work)
  446. ;
  447. ;   z --- leave dired processor (Dired-buffer becomes like any other)
  448. ;
  449. ;   Note that file or directory inputs to Dired are globbed
  450. ;   so that ~/filename is expanded using you $HOME variable
  451. ;   (only ~/ is expanded though).
  452. ;
  453. ;   Filenames and directories entered for copy, move, etc., are 
  454. ;   processed as follows: a single name gets the currently viewed 
  455. ;   directory prepended to it. If the filename/dir is entered with 
  456. ;   "/"'s in it, it's assumed that it represents a full pathname 
  457. ;   and left alone. ".." is a valid directory and will be expanded 
  458. ;   relative to the viewed directory.
  459. ;
  460. ;   C-x C-f (find-file) while in a some directory, opens a (new) file 
  461. ;                       in that directory.
  462. """"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
  463.    * Other Operating Systems *
  464.  
  465.       I haven't done any work with other systems than DOS and
  466.       Unix on a Sparc, Sun 3, and an RISC 6000. Dired should 
  467.       work fine though with perhaps a small bit of modification.
  468.       If you do this please write me about it, so I can credit
  469.       you and add your changes to new versions.
  470.  
  471.  
  472.  
  473.    PLEASE REPORT BUGS! (or delights). These projects work because
  474.    of a worldwide network of users who contribute their ideas and
  475.    time. If something goes wrong, please let me know so I can fix it.
  476.    On the other hand if you find you like this little piece of code,
  477.    don't hesitate to drop me a note saying so; it'll make my day a 
  478.    bit more pleasant.
  479.  
  480.    Thanks very much to Richard Meitzler for the 4DOS fix and for
  481.    beta testing this 1.1 version.
  482.  
  483.    That's about it. The above notes are also mentioned in the 
  484.    headers of each dired file.
  485.  
  486.  
  487.    Enjoy your time,
  488.  
  489.          Jim
  490.    
  491. ==============================================================
  492. James E. Hetrick            Institute for Theoretical Physics
  493. hetrick@phys.uva.nl                     -\|/-
  494.  
  495. University of Amsterdam
  496. Valckenierstraat 65, 1018 XE Amsterdam
  497. Telephone: +31 20 525 5663 Fax: +31 20 525 5788
  498. ===============================================================
  499.