@Database "Epoch_CLI.2.0.Guide" @rem 'AmigaGuide' version © EarlyBird Software 1994 converted from the @rem original plain text document © C.S.J.Brady 1994. @rem @rem Thanks Derek :-) @node main "Epoch CLI v2.0 - Contents" @{b}Epoch CLI V2.0@{ub} @{i}© C.S.J.Brady 1994@{ui} @{u}Table of contents@{uu} @{" 1. " link 1} Distribution @{" 2. " link 2} Changing @{i}EpochCLI@{ui} @{" 3. " link 3} Shareware Notice @{" 3.1" link 3.1} Delay in replying to post @{" 4. " link 4} Why @{i}EpochCLI@{ui} ? @{" 5. " link 5} Redirection Of Output @{" 6. " link 6} Using @{i}EpochCLI@{ui} In Script Files. @{" 7. " link 7} Options and @{"Examples" link 7eg} @{" 8. " link 8} Printing @{" 9. " link 9} Known 'Problems'! @{" 10. " link 10} Feedback @{" 11. " link 11} Thanks to..... @{" 12. " link 12} Revision History @endnode @node 1 "Distribution" @next 2 @{b}Program Distribution@{ub} There are two versions of this of Epoch CLI v2.0. 1. Un-registered versions which may be freely distributed by anyone apart from organisations that - claim copyright to programs on their systems - charge more than a "reasonable amount" for the cost of disks and postage. Any magazine or CD-ROM compiler distributing this program must contact me before distributing the program. Any subscription only BBS or 0898 BBS must also contact me before they may distribute this program. 2. @{"Registered" link 1.1} versions. These may NOT be freely distributed, they are versions that only I, C.S.J.Brady, and Jack Pritchard can legally distribute. @endnode @node 1.1 "Registered Versions" @{b}Customising@{ub} If you require Epoch_CLI to do something differently to the way it is done at the moment then you will have to write to Chris Brady directly. If the change is only likely to be of benefit to you please send a stamped addressed envelope with a disk and I'll see what I can do. Please note that people that have not registered my program will quite simply be ignored. @{b}Additions to Version 2@{ub} If you want to see an extra function in my program please write and tell me what it is (and how to do it!). The only postscript that I will add is that I don't want to change the file. If your idea requires that the file changes please contact @{"Jack Pritchard" link 4.1}. If send a request without registering please expect it to be ignored ! Please see @{"delay " link 3.1} notice. @endnode @node 2 "Changing EpochCLI" @prev 1 @{b}Changing @{i}EpochCLI@{ui}@{ub} @{b}NO ONE@{ub} may tamper with this software in any way; this includes, but is not limited to, reverse engineering, recompiling, editing the executable or document files. If you require the @{i}EpochCLI@{ui} to do @{"something differently" link 1.1} to the way it does it at the moment, or you require the program to do @{"something extra" link 1.1} you should contact me. If you need to contact me please note that there may be a @{"delay" link 3.1} in replying to post. @endnode @node 3 "Shareware Notice" @prev 2 @next 3.1 @{b}@{i}Epoch CLI V2@{ui} and YOU@{ub} I have decided to release version two into the public domain as @{b}SHAREWARE@{ub}. I have spent a lot of time on this version and I also spent a lot of time writing v1, and I therefore decided that I should gain some reward. Unfortunately I will be very busy over the next year and so I will not be able to reply to post particularly quickly. It is because of this that Jack Pritchard and myself have agreed the following. NB. The price of Epoch Master may vary depending on the package you order and the current version. The price £10 is just an example! To register Jack Pritchard's program Epoch Master you should send £10 to his address. If you send £10 you will just get a registered version of Epoch master, however if you send £13 you will get registered copies of both Epoch Master and Epoch CLI. You can not register just my program, you must also register Jack's program. If you have already registered Jack's program then you may just send £3 to register my program, but please note, Jack may not send you a copy of Epoch CLI until he writes to you again. If you require your copy of Epoch CLI quickly then please send Jack a stamped addressed envelope with a disk, and he'll obviously try to respond a little faster. This means that I don't have to spend my time distributing a @{"registered" link 1.1} version and you don't have to send as much (I wont have any postage and disk charges to pay). You also only have to pay one set of postage etc yourself rather than having to pay two separate people. The minimum contribution for Epoch Master is £10, for Epoch CLI it is £3. If you send more please say how much you are contributing to each program, ie. I have sent £15 for Jack and £0 for Chris (£15 sent in total), or I have sent £10 for Jack and £5 for Chris (again £15 in total). Please note :if you need to contact me there may be a @{"delay" link 3.1} in replying to post. The shareware version will only deal with 10 entries and will only do a day planner for the 28th of October 1994 (28.10.1994). @endnode @node 3.1 "Delay in replying to post" @next 4 @{b}Delay in replying to post@{ub} Please note that @{i}after@{ui} August 1994 there could be a substantial delay in getting a reply to any correspondence, please be as patient as you can. This is why I have released the full version via Jack Pritchard, so that people don't have to wait too long to receive their registered version. @endnode @node 4 "Why EpochCLI ?" @next 5 @{b}Why Epoch CLI was written@{ub} @{i}EpochCLI@{ui} was written by me as an alternative to @{i}EpochGlance@{ui} written by @{b}J.Pritchard@{ub}. @{i}EpochGlance@{ui} requires that the user uses the mouse while scanning the directory outside the main @{"Epoch Master" link 4.1} program, and prints its output to a separate window. @{i}EpochCLI@{ui} can also do a few things that @{i}Epoch Master@{ui} can not currently do, for example the @{u}day planner@{uu}. @endnode @node 4.1 "Epoch Master © Jack Pritchard" @prev 4 @next 4.1 @{b}@{i}Epoch Master@{ui}@{ub} © Jack Pritchard @{i}EpochCLI@{ui} uses the calendar file (default name and path S:EpochCal) which is produced by @{i}Epoch Master@{ui} which is © @{b}J.Pritchard@{ub} 1994. Epoch Master is SHAREWARE; shareware contributions of £10 should be sent to @{b}J.Pritchard@{ub} at @{b}HIS@{ub} address, which is: 5 Parklands Close, Gosport, Hampshire. England. PO12 4XJ In fact, @{i}EpochCLI@{ui} is useless without such a calendar file. @endnode @node 5 "Redirection Of Output" @prev 4 @next 6 @{b}Redirection and @{i}EpochCLI@{ui}@{ub} If you wish to use @{"redirection" link 5.1} when using @{i}EpochCLI@{ui} use the @{b}-p@{ub} option as this will stop the @{i}EpochCLI@{ui} from waiting for you to press @{b}@{ub} after each entry and also sends the output to the CLI/SHELL window (which is needed when using redirection). To do this type :- epoch_cliV2.0 >>ram:diary.txt s:epochcal -p Replace @{b}s:epochcal@{ub} with the filename that you use for your calendar file and replace @{b}ram:diary.txt@{ub} with the file that you want to send output to. The @{b}-p@{ub} is a @{b}requirement@{ub}, otherwise, you will be presented with the 'normal' @{i}EpochCLI@{ui} window. Refer to @{"Option Examples" link 7eg} for further details. @endnode @node 5.1 "Redirection Of Output" @prev 5 @next 5.1 @{b}Redirection Of Output@{ub} @{b}NB@{ub} The @{i}first@{ui} argument must be the calendar file that you wish to read. The output from @{i}EpochCLI@{ui} can be made to go straight to the CLI window from which it was run. Output from @{i}EpochCLI@{ui} can therefore be directed to a file, which is useful for subsequent editing, in the normal CLI/Shell way e.g. "program >PATH:file" sends the output to a new file (a file will be created automatically, a file with the same name, if present, is DELETED). The command "program >>PATH:file" will send the output to a new file, if a file called "file" doesn't exist, or it will append the output to the file if the file already exists. @endnode @node 6 "Using EpochCLI In Script Files" @prev 5 @{b}Using @{i}EpochCLI@{ui} In Script Files@{ub} To use @{i}EpochCLI@{ui} in your startup-sequence I recommend that you use the following lines in the startup-sequence of your system (boot) disk (this is Workbench 1.3 , no one has told me that it doesn't work with higher versions, nor has anyone told me that it does work....!) :- ask "*e[33mCheck Diary ?*e[0m {y/n}" if WARN epoch_cliV2.0 s:epochcal echo "Checked Diary" else echo "Did not check diary" endif Please ensure that you have the commands "ask", "if", "else", "endif", "echo" and "epoch_cliV2.0" available on the current (search) path, for example in the C: directory of the system (boot) disk. You may use any legal @{"options" link 7} after the program name. e.g. epoch_CLIV2.0 >ram:day_plan -d ed ram:day_plan delete ram:day_plan Would create a file containing the output from the day plan function, display it using ed and then (once you have quitted ed) delete the file. Some file viewers (not ed) allow you to print the file, so you may like to use a different file viewer. @endnode @node 7 "Available Options" @next 7eg @{b}Available Options@{ub} In order to change the output from @{i}EpochCLI@{ui}, the following command line options are available: @{" 1. " link 7.1} b Searching For The Next Entry To Occur @{" 2. " link 7.2} d Day Planner @{" 3. " link 7.3} h Help @{" 4. " link 7.4} i Use of the system Clock @{" 5. " link 7.5} mxx Setting Number Of Entries To Print @{" 6. " link 7.6} s Creating A Summary Diary @{" 7. " link 7.7} o Sort by Occasion @{" 8. " link 7.8} c Sort by Category @{" 9. " link 7.9} p Redirect output @{b}NB. ALL@{ub} output is from the @{i}next@{ui} available entry after the System Date unless the @{"-b" link 7.1} option is used, or you have sorted the records (used -o or -c), in which case the -b option is automatically set. Refer to @{"Option Examples" link 7eg} for further details. @endnode @node 7.1 "Searching for The Next Entry To Occur" @prev 7 @next 7.1 @{b}Searching for the next entry to occur@{ub} : the -b option ** A Change from version 1 ** It used to be the {"-c" link 7.8} option, that is now used to sort the records by category. The @{b}-b@{ub} option stops the program from searching for the next entry that will occur (which is the default). If you don't use this option you may find that the program starts displaying on, for example, the 6th entry, this is not a bug ! Refer to @{"Option Examples" link 7eg} for further details. @endnode @node 7.2 "Day Planner" @prev 7 @next 7.2 @{b}Day Planner@{ub}: the -d option This option allows you to create a day planner, using the entries in the specified file. It provides you with a log containing all the entries for the appropriate date inserted within their respective 'time zones'. A new entry in each zone is highlighted by @{b}-->@{ub}. If you use just @{b}-d@{ub} then you will be given a day planner for the current system date. This is produced regardless or whether you actually have any entries. This is very handy if you wish to complete a 'paper' log of the day's activity. You may also specify a date of your choice by using the command @{b}-d@ub} where @{b}@{ub} is in the format dd.mm.yyyy For example -d28.10.1994 would give you a day planner for the 28th of October 1994 (Chris Brady's birthday :-) ). Refer to @{"Option Examples" link 7eg} for further details. @endnode @node 7.3 "Help" @prev 7 @next 7.3 @{b}Help@{ub}: the -h option This option displays a few lines of text that should help you to use @{i}Epoch_CLI@{ui}. It simply gives a list of the available @{"options" link 7} and how to use them, along with some pertinent program details such as where to contact me!. You will also get help if you use "?" which is the CLI 'standard'. However if you are reading this document you wont need any help will you ? @endnode @node 7.4 "Use Of The System Clock" @prev 7 @next 7.4 @{b}Use of the system clock@{ub} : the -i option @{i}EpochCLI@{ui} uses the system date and so you need to have set your system clock before you run the program, using "setclock load". If you don't have a system clock use the @{b}-i@{ub} option when running the program, as this stops @{i}EpochCLI@{ui} loading and using the system date. There is no need to use this option with the @{b}-p@{ub} option as the system date is not currently used when using the @{"-p" link 7.9} option. There is no need to use the @{"-c" link 7.8} option if you use the @{"-i" link 7.4} option. @endnode @node 7.5 "Setting The Number Of Entries To Print" @prev 7 @next 7.5 @{b}Setting number of entries to print@{ub} : the -mxx option If you have used the print option (@{"-p" link 5}) you may also give a maximum number of entries to use. eg epoch_cliv2.0 >ram:diary s:epochcal -p -s -m20 will mean that only the first twenty records are printed (after any sorting has been carried out. There can not be any gap between @{b}-m@{ub} and the number. The default maximum number of entries is 9999. If you wish to print out more than this you will need to write to me (if you have the time!). A number larger than the number of entries in the file is allowed, as you are specifying the @{b}MAXIMUM@{ub} number of entries that will be printed. Refer to @{"Option Examples" link 7eg} for further details. @endnode @node 7.6 "Creating A Diary Summary" @prev 7 @next 7.6 @{b}Creating a diary summary@{ub} : the -s option If you use the option @{b}-s@{ub} when running @{i}EpochCLI@{ui} then you will only be given a brief summary of each entry in your S:epochcal file. This option can be used in conjunction with the @{"-p" link 5} option to create a table of entries. This option may also be used when printing to the window, i.e. when not using the @{b}-p@{ub} option. @{b}NB@{ub} The whole file still has to be read when using this option and so don't use it to save time or memory, you don't! Example :- epoch_cliv2.0 >ram:diary.txt s:epochcal -s -p Refer to @{"Option Examples" link 7eg} for further details. @endnode @node 7.7 "Sorting by Occasion" @prev 7 @next 7.8 @{b}Sorting by Occasion@{ub} : the -o option As you may be able to guess this option allows you to sort all entries by the occasion field. The sorting after the file has been loaded and so if you also use the @{"-m" link 7.5} option then you will only get the first records @{b}AFTER@{ub} sorting has taken place. Refer to @{"Option Examples" link 7eg} for further details. @endnode @node 7.8 "Sorting by Category" @prev 7 @next 7.9 @{b}Sorting by Category@{ub} : the -c option As you may be able to guess this option allows you to sort all entries by the category field. The sorting after the file has been loaded and so if you also use the @{"-m" link 7.5} option then you will only get the first records @{b}AFTER@{ub} sorting has taken place. @endnode @node 7.9 "Redirecting output" @prev 7 @{b}Redirecting Output@{ub} : the -p option See @{"Redirection of output" link 5}. Refer to @{"Option Examples" link 7eg} for further details. @endnode @node 7eg "Option Examples" @prev 7 @{b}Option Examples@{ub} The following examples illustrate various @{"option" link 7} combinations: EpochCLI >Ram:YourfileName -p -o -s -m3 Provides up to a maximum of 3 diary entries, in summary format, @{b}AFTER@{ub} they have been sorted by occasion. NB : the @{"-b" link 7.1} option is automatically used if you sort the file. EpochCLI >Ram:YourfileName -p -d Provides a Day Planner for the current system date. (Not available on the shareware version) EpochCLI >Ram:YourfileName -p -d16.06.1984 (Not available on the shareware version) Provides a Day Planner for 16 June 1984 (Derek Bird's birthday :-)) @endnode @node 8 "Printing" @prev 7 @{b}Printing from within the program@{ub} You are now able to print individual records from within the program, use: '@{b}F@{ub}' for a full printout ie. Date, Time1, Time2, Occasion, Cat(egory), Location Plus Diary Notes if appropriate. '@{b}S@{ub}' for a summary printout. ie. Date, Time1, Time2, Occasion, Cat(egory), Location without these headings or the Diary Notes. Please note that your printer must be connected and 'on-line'. If you use this option you will not be able to exit until your printer has accepted all the data sent. This is not normally a problem but if you try and print when your printer is not available you will have to wait for the intuition requester to appear so that you can cancel the use of the printer, @{i}EpochCLI@{ui} will then be able to release the resource and quit. This function is included for completeness, however I recommend that you print records by using the @{b}-p@{ub} option and (editing and then) printing the resulting output. The program may not start printing until the buffer is full or until you try and quit the program. @endnode @node 9 "Known Problems" @prev 8 ** CHANGES FROM VERSION 1 ** Please note, you must now enter the password for non-encrypted files. @{b}Encrypted files@{ub} are now recognised and dealt with. @{b}Notes in entries@{ub} You will be told if there are any notes relating to the entry but they will not be displayed. In the @{"day planner" link 7.2} a line of diary notes may be too long to fit, if this happens as much of the line as possible will be printed and you will be notified that some data has been lost. If this causes any problems please notify @{"Chris Brady" link 10}. @{"Printing" link 8} records directly from within the program is not recommended. @endnode @node 10 "Feedback" @{b}Feedback about EpochCLI@{ub} If you have any questions, comments or queries relating to @{i}EpochCLI@{ui} then please write to me (@{b}Chris Brady@{ub}) at my address below. If you want a reply please enclose a stamped addressed envelope and/or some money, otherwise I may not be able to reply. 5 Hill Grove, Salendine Nook, Huddersfield. West Yorkshire. England. HD3 3TL. @{b}Feedback about Epoch Master@{ub} If you have any questions, comments, or queries relating to @{i}Epoch Master@{ui} then please write to @{"J. Pritchard" link 4.1} at his address. Please support the AMIGA by supporting the @{b}SHAREWARE@{ub} concept. @{"Thanks to" link 11} @{b}Jack Pritchard@{ub},@{b}Derek Bird@{ub} and the 3 people that sent postcards as requested in responce to the Epoch_CLIV1 document. @{b}Chris Brady@{ub} @endnode @node 11 "Thanks to......" Jack Pritchard For giving me the details of the calendar file format and for the information needed to decode encoded files. Also for his encouragement to write Epoch CLI in the first place! Derek Bird For hours of beta testing and for writing this guide file, and for being honest about my program (the most important quality that a beta tester must have!). He has also sent me many ideas for my program, some of which are in this version, and others that will hopefully appear in the future. The three people that sent me postcards, its nice to know that some people can still read ! @endnode @node 12 "Revision History" @{b}Revision History@{ub} @{u}Version@{uu} @{u}Released@{uu} @{u}Details@{uu} 1.00 Jul 1994 Initial release with @{i}Epoch Master@{ui} 2.00 2.01 Aug 1994 - Sort the entries by occasion &/or by category - Maximum entries option added - Day planner option added - Use Yesterday and Today rather than 1 day ago/1 days time - Blank lines are not printed when using the print (-p) option (V1 printed them) - You must now input the password (if appropriate) (NB You will see the password as you enter it) - Epoch CLI can now read encrypted files @endnode