From 1d97dd1823de712d178a101e015af28f31f2e7fa Mon Sep 17 00:00:00 2001 From: Bobbi Webber-Manners Date: Fri, 22 May 2020 20:14:09 -0400 Subject: [PATCH] More README updates --- README.md | 87 +++++++++++++++++++++++++++++++++++++------------------ 1 file changed, 59 insertions(+), 28 deletions(-) diff --git a/README.md b/README.md index f563826..66d295e 100644 --- a/README.md +++ b/README.md @@ -11,7 +11,6 @@ a directory tree or an entire volume: - Multi-level directory sort - Manipulating the case of filenames * - Manipulating the format of time and date information * - - Zeroing free blocks *Sortdir* is intended to help users migrate to the new ProDOS 2.5 release, which is currently in alpha. The code has been testing with ProDOS 2.5a8, @@ -72,7 +71,65 @@ overwritten.) ![](/Screenshots/Interactive.png) -TODO +When *Sortdir* is launched without any command line parameters, a very +primitive interactive user interface is shown, as seen above. The program +asks questions sequentially. If you make a mistake and want to go back, +entering the `^` (caret) character will go back to the previous question. + +When in doubt, the `-` (minus) character is mapped to the most conservative +choice for each option. + +The following prompts are presented in order: + + - *Path of starting directory* Enter an absolute or relative path here. + The directory operations will start in this directory (unless the + 'whole volume' option is selected, in which directory operations will + begin in the volume directory of the of the volume which contains the + directory specified here.) + - *What to process ...* There are three options: + - `-` - Only operate on the specified directory. + - `r` - Operate recursively, descending the tree from the specified + directory. + - `v` - Operate on the entire volume, descending the tree from the volume + directory. + - *Multi-Level directory sort ...* Here you can enter up to four levels of + directory sorting. For each level, the following choices are available: + - `n` - Sort by filename in ascending alphabetical order (A-Z). + - `N` - Sort by filename in descending alphabetical order (Z-A). + - `i` - Sort by filename in ascending alphabetical order (A-Z) in a case + insensitive manner. + - `I` - Sort by filename in descending alphabetical order (Z-A) in a case + insensitive manner. + - `d` - Sort in ascending order of modification time/date. + - `D` - Sort in descending order of modification time/date. + - `t` - Sort in ascending order of file type (considered as an integer) + - `T` - Sort in descending order of file type (considered as an integer) + - `f` - Sort in directories ("folders") to the top. + - `F` - Sort in directories ("folders") to the bottom. + - `b` - Sort in ascending order of file size in blocks. + - `B` - Sort in descending order of file size in blocks. + - `e` - Sort in ascending order of file size in bytes (ie: EOF position). + - `E` - Sort in descending order of file size in bytes (ie: EOF position). + - `-` - Entering `-` (minus) will end the entry of sort options and move + on to the next section. + - *Filename case conversion ...* + - `-` - + - `l` - + - `u` - + - `i` - + - `c` - + - *On-disk date format conversion ...* + - `-` - + - `n` - + - `o` - + - *Attempt to fix errors? ...* + - `-` - + - `?` - + - `a` - + - *Allow writing to disk? ...* + - `-` - + - `w` - + ### Command Line Options @@ -112,29 +169,3 @@ time format back to the legacy format. Not yet implemented in ProDOS-8 version. -### Directory Check and Repair - -TODO - -### Directory Sort - -TODO - -### Filename Case Change - -TODO - -### Date and Time Format - -This allows the format of the modification time and creation time fields in -ProDOS directories to be converted from the legacy ProDOS format (ProDOS <2.5) -to the new date and time formats introduced in ProDOS 2.5. These new formats -extend the range of dates that may be represented, in a backwards-compatible -manner. *Sortdir* also allows conversion from the new ProDOS 2.5 date and -time format back to the legacy format. - -### Zeroing Free Blocks - -Not yet implemented in ProDOS-8 version. - -