home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Professional / OS2PRO194.ISO / os2 / diskutil / nemo / nemo.doc < prev    next >
Text File  |  1993-08-31  |  12KB  |  358 lines

  1.  
  2.          Captain Nemo for OS/2 2.0
  3.         Version 0.2,  August 31, 1993
  4.  
  5.         Copyright (C) 1993 by Adam Mirowski
  6.  
  7. $Id: nemo.doc 1.27 93/08/31 03:12:10 ROOT_DOS Exp $
  8.  
  9. Introduction
  10. ------------
  11.  
  12. "Captain Nemo" is a text-mode shell program for OS/2.
  13. It tries to imitate the Norton Commander (R) for DOS
  14. v.2 as closely as possible and yet realize a smooth
  15. integration with OS/2 features. I started writing it
  16. last March, after receiving my copy of NC for OS/2
  17. and not being satisfied by it.
  18.  
  19. This version 0.2 is the second alpha release. It is free,
  20. but incomplete, buggy and full of possibly useless checks
  21. that slow down execution and waste memory.
  22.  
  23. Captain Nemo version 0.2 is distributed in the hope that
  24. it will be useful, but WITHOUT ANY WARRANTY; without even
  25. the implied warranty of MERCHANTABILITY or FITNESS FOR A
  26. PARTICULAR PURPOSE. You can use at your own risk, and
  27. report whatever problems you have encountered with it.
  28. You are free to copy this software ONLY if you include this
  29. document file with it. You may NOT charge anyone for a copy
  30. of this software other than a small copying fee. You may NOT
  31. include this software with any commercial software without
  32. the written consent of the author.
  33.  
  34. As I said, this version is free, but donations will be
  35. gratefully accepted. A suggested amount is $20.
  36.  
  37. You can contact me either by writing an e-mail to:
  38.  
  39.     Adam Mirowski <mir@chorus.fr>
  40.  
  41. or sending a letter to:
  42.  
  43.     Adam Mirowski
  44.     Residence Les Cypres
  45.     10, rue Caruel de Saint-Martin
  46.     F-78150 Le Chesnay
  47.     FRANCE
  48.  
  49. You can phone me at +33 (1) 30-64-82-74 (business) or
  50. +33 (1) 39-54-27-34 (home). Please note that I live in
  51. the GMT+2 time zone.
  52.  
  53. Features
  54. --------
  55.  
  56. Since you are probably more interested in what is
  57. missing than in what is present, let's start by a
  58. non-features list.
  59.  
  60. Currently there is no:
  61.  
  62.     - F9/[LR]/T    tree panels
  63.     - Alt-F10    NCD tree
  64.     - <auto>    mouse support
  65.     - <auto>    full country information utilisation
  66.             (the  DD/MM/YY  HH:MM  format is used)
  67.     - <auto>    scrollbars in the user menu box (which is
  68.             limited to 19 entries)
  69.  
  70. Modifications since the first released version are listed in the
  71. file 'whats-up.doc'.
  72.  
  73. These features are special to Captain Nemo:
  74.  
  75.     - <auto>    specific "Hpfs" directory format for HPFS disks,
  76.             allowing up to 16 visible chars on 80 char wide
  77.             displays and up to 38 on 132 chars.
  78.             Also used in the logical naming mode.
  79.  
  80.     - F9/O/M    Mini-Status windows can show up to 38 or 64 first
  81.             chars of filenames, if needed.
  82.  
  83.     - Alt-F5    "logical file naming" mode in which files can be
  84.             identified and manipulated using arbitrary logical
  85.             names rather than hardware 8.3 MS-DOS names.
  86.             This makes FAT disks appear like HPFS ones,
  87.             and is also compatible with the Workplace Shell
  88.             naming (you can rename each other's objects using
  89.             alternatively NEMO and WPS).
  90.  
  91.     - ^F6        logical filename creation
  92.  
  93.     - <auto>    extended attributes support: EAs follow owning files
  94.             when those are copied or moved;
  95.  
  96.     - Alt-F6    132 column display support
  97.       F9/C/L
  98.  
  99.     - F9/O/R    screen-saver (didn't exist in NC v.2)
  100.     - <auto>    the extension file can have an unlimited length
  101.     - F9/O/V    the viewer can be set to an external executable
  102.     - <auto>    history elimination is case-sensitive
  103.     - grey*        inversion of file tags by mask
  104.     - <auto>    unix-style text file support in the viewer
  105.     - F9/O/N    case-sensitive file sorting
  106.     - F9/O/T    reverse file sorting
  107.     - Alt-Enter    pasting of the current directory into command line
  108.  
  109.     - Shift-Enter    execution of current line preceeded by a user-defined
  110.             prefix, 'start ' by default. Also execution of
  111.             extension-defined commands, when pressing
  112.             Shift-Enter over filename.
  113.  
  114.     - !*        insertion of the list of currently selected files
  115.             into a command defined through the extension file
  116.             or the external editor/viewer call line.
  117.  
  118. These features are shared with the reference program:
  119.  
  120.     - <auto>    a 100% NC for DOS v.2 look including colors;
  121.     - F9/[LR]/B    "Brief" and
  122.       F9/[LR]/L    "Long" directory formats for FAT disks;
  123.     - <auto>    fully functional command line editor, also in all
  124.             dialog boxes, including a "hysteresis" backscroll.
  125.     - <auto>    interaction between panels and command line,
  126.       ^Enter    including filename pasting
  127.     - <auto>    full and unlimited length extension file nemo.ext
  128.             with !, .!, !:, !\ and !! handling;
  129.     - X:   CD..    transparent capture of disk and directory changes
  130.       CD\  CD    and display performed using the command line.
  131.       CD <dir>    Error messages are native OS/2 messages for
  132.             full OS/2 CMD.EXE illusion;
  133.  
  134.     - INS         file tagging, preserved between shell command
  135.             execution and pane hiding;
  136.     - DEL        char deletion;
  137.     - grey-        file untagging by mask;
  138.     - grey+        file tagging by mask;
  139.     - Alt-...    file selecting by initials;
  140.     - arrows    operate differently according to the
  141.             type of the current pane, if any;
  142.     - HOME/END    operate  differently according to
  143.             the type of the current pane, if any;
  144.     - PageUp/Down    100% NC's funny logic;
  145.  
  146.     - F1        display help page;
  147.     - F2        nemo.mnu user menu, local and global;
  148.     - F3        viewer (can be disabled and set to an external
  149.             executable through Options/Viewer);
  150.     - F4        external editor (name can be set through a
  151.             Options/Editor);
  152.     - F5        file copying, individual and tagged, with
  153.             full wildcard support and full set of
  154.             informational and error messages;
  155.     - F6        file moving, directory renaming, with full
  156.             wildcard support and full set of informational
  157.             and error messages;
  158.     - F7        directory creation;
  159.     - F8        file/dir deletion, individual and tagged;
  160.     - F9        activate menu bar, turn on "Left" or "Right"
  161.             accordingly to the current panel;
  162.     - F10        quit
  163.  
  164.     - Alt-F1    disk selection
  165.     - Alt-F2    disk selection
  166.     - Alt-F3    view currently selected file using alternate viewer
  167.     - Alt-F4    edit currently selected file using alternate editor
  168.     - Alt-F5    Toggle usage of logical names
  169.     - Alt-F6    Toggle 132 column mode vs. 80 column mode
  170.     - Alt-F7    Find file
  171.     - Alt-F8    history box
  172.     - Alt-F9    43/50 lines
  173.     - Alt-F10    <not yet supported>
  174.  
  175.     - Shift-F1    <no action>
  176.     - Shift-F2    <no action>
  177.     - Shift-F3    arbitrary file viewing
  178.     - Shift-F4    arbitrary file editing
  179.     - Shift-F5    file copying/renaming by mask
  180.     - Shift-F6    file moving/renaming by mask
  181.     - Shift-F7    directory creation
  182.     - Shift-F8    file/dir deletion
  183.     - Shift-F9    save nemo.ini binary config file
  184.     - Shift-F10    <no action>
  185.  
  186.     - Ctrl-F1    turning left pane on/off
  187.     - Ctrl-F2    turning right pane on/off
  188.     - Ctrl-F3    <no action>
  189.     - Ctrl-F4    <no action>
  190.     - Ctrl-F5    <no action>
  191.     - Ctrl-F6    <no action>
  192.     - Ctrl-F7    <no action>
  193.     - Ctrl-F8    <no action>
  194.     - Ctrl-F9    <no action>
  195.     - Ctrl-F10    <no action>
  196.  
  197.     Ctrl-key combinations:
  198.     - ^A        word left
  199.     - ^B        keybar switching
  200.     - ^C        no action in command line, page down in editor
  201.     - ^D        one char forward
  202.     - ^E        previous history entry in command line, line up
  203.             in editor and in viewer
  204.     - ^F        word right
  205.     - ^G        delete char under cursor
  206.     - ^H        backspace
  207.     - ^I        switch to other panel if any
  208.     - ^J        paste pane selection into command line
  209.     - ^K        killing line end
  210.     - ^L        info panels
  211.     - ^M        execute command line
  212.     - ^N        open menu bar and select current panel menu
  213.     - ^O        panels on/off
  214.     - ^P        non-current pane switching
  215.     - ^Q        <no action>
  216.     - ^R        changing disk for current pane in command line,
  217.             page up in editor
  218.     - ^S        one char backward
  219.     - ^T        delete word right
  220.     - ^U        swap panels
  221.     - ^W        delete word left
  222.     - ^X        next history entry in command line, line down in editor
  223.             and in viewer
  224.     - ^Y        delete command line
  225.     - ^Z        <no action>
  226.     - ^Home        goto start of line
  227.     - ^End        goto end of line
  228.     - ^BS        delete word right (same funny semantics
  229.             for finding the char to stop on as in NC)
  230.  
  231.     - F9/[LR]/B    brief directory format
  232.     - F9/[LR]/F    full directory format
  233.     - F9/[LR]/I    information
  234.     - F9/[LR]/O    pane on/off switching
  235.     - F9/[LR]/[NXSMU]
  236.             all sorting options
  237.     - F9/[LR]/R    directory re-read
  238.     - F9/[LR]/D    drive selection
  239.  
  240.     - F9/F/H    help
  241.     - F9/F/U    user menu
  242.     - F9/F/V    view file
  243.     - F9/F/E    edit file
  244.     - F9/F/C    copy files
  245.     - F9/F/M    move files
  246.     - F9/F/M    make directory
  247.     - F9/F/D    delete files/directory
  248.     - F9/F/G    tag group of files by mask
  249.     - F9/F/N    untag group of files by mask
  250.     - F9/F/I    invert tagged status of files by mask
  251.     - F9/F/Q    quit NEMO
  252.  
  253.     - F9/C/H    history menu
  254.     - F9/C/E    EGA lines
  255.     - F9/C/S    swap panels
  256.     - F9/C/L    toggle 132 column mode
  257.     - F9/C/.    toggle logical name usage
  258.     - F9/C/P    panels on/off
  259.     - F9/C/C    compare directories (warning: like in NC, comparing is
  260.             only on existence/date/time. Not on size, attributes
  261.             nor EAs.)
  262.     - F9/C/M    menu file edit
  263.     - F9/C/X    extension file edit
  264.  
  265.     - F9/O/C    color dialog box
  266.     - F9/O/C/B    black and white display mode
  267.     - F9/O/C/C    color display mode
  268.     - F9/O/C/L    laptop display mode
  269.     - F9/O/A    auto menus on/off
  270.     - F9/O/P    path prompt switching vs. disk-only prompt
  271.     - F9/O/K    key bar on/off
  272.     - F9/O/F    full screen vs. half screen
  273.     - F9/O/I    ins moves down on/off
  274.     - F9/O/L    clock on/off
  275.     - F9/O/V    viewer selection
  276.     - F9/O/V/B    built-in viewer selection
  277.     - F9/O/V/E    external viewer selection and defining
  278.     - F9/O/E    editor selection
  279.     - F9/O/E/B    built-in editor selection
  280.     - F9/O/E/E    external editor selection and defining
  281.     - F9/O/R    screen-saver time-out adjusting
  282.     - F9/O/N    case-sensitive file sorting
  283.     - F9/O/T    reverse file sorting
  284.     - F9/O/H    Shift-Enter prefix definition
  285.     - F9/O/S    save setup
  286.  
  287. Known bugs
  288. ----------
  289. Known bugs are listed in the 'bugs.doc' file.
  290.  
  291. Remarks
  292. -------
  293. [1]  Nemo always uses DOS file selection mechanism, ie. the last dot
  294.      of a file name is considered as "the" dot and the other are seen
  295.      as ordinary chars.
  296.  
  297. [2]  OS/2 locks files and directories when used or current for a
  298.      process, so you cannot remove them, nor change their physical
  299.      or logical names.
  300.  
  301. [3]  Use ^ in logical names to obtain a newline effect on the WPS
  302.      desktop. You can even enter the ^ in the WPS, and as soon as
  303.      you validate the name change it will be transformed into a
  304.      visual newline.
  305.  
  306. [4]  Logical name support is still very uncomplete and somewhat
  307.      incoherent. Physical names are never updated when changing
  308.      logical ones. It is possible to have two files under the
  309.      same logical name, for example when copying a non-8.3 file
  310.      from an HPFS disk to a FAT disk and then back.
  311.  
  312. [5]  If you want an arbitrary number of screen lines (columns
  313.      must be either 80 or 132), execute the OS/2 "MODE" command
  314.      before or from within Nemo.
  315.  
  316. [6]  It is not possible to have 132 columns in a window. This is
  317.      a limitation of OS/2 windowed sessions.
  318.  
  319. [7]  A command file (.CMD) cannot modify Nemo's current disk, nor
  320.      directory. This is because Nemo executes the .CMD file in a
  321.      separate child process and child processes don't communicate
  322.      their current disk/directory to their parent on exit. I don't
  323.      plan to incorporate a .CMD file interpreter into Nemo right now.
  324.  
  325.      For the same reason, it is not possible to use Nemo to change
  326.      the current disk or directory.
  327.  
  328. [9]  The initial message box will not be displayed if Nemo founds
  329.      a 'nemo.ini' setup file.
  330.  
  331. [10] The viewer uses different display algorithms when scrolling
  332.      backward and when scrolling forward. This may change the
  333.      appearance of lines which are over 78 characters. NC exhibits
  334.      similar differences.
  335.  
  336. Acknowledgements
  337. ----------------
  338. Benoit Poulot and Kai Uwe Rommel helped me a lot during the
  339. development.
  340.  
  341. The following people have provided bugs reports, ideas and
  342. (sometimes clinking) encouragements:
  343.  
  344. Martin Borstom, Egons Bush, Harry Bush, H. Choe, Oscar M. Fowler,
  345. Frans Goddijn, Simon Goland, Kordt Griepenkerl, Anthony Guetmansky,
  346. Jon Hacker, Lars Jorgensen, Eduard Kappel, Leon Loo, Magnus L|vkvist,
  347. James Mehl, Matthias Rabe, Christian Rettner, Richard Stanton,
  348. Morio Taneda, Eric Trepanier, Paul Tylich and William T. Warner.
  349.  
  350. Sorry if not all their ideas have find their way into this 0.2 release.
  351.  
  352. Paul Tylich is also the author of the alternate Captain Nemo icon.
  353.  
  354. Trademarks
  355. ----------
  356. "Norton Commander" (R) is a registered trademark of the
  357. Symantec Corporation.
  358.