More documentation work.

This commit is contained in:
Bobbi Webber-Manners 2020-10-29 17:24:24 -04:00
parent 4f79f4cb40
commit fbc3c2cccc
12 changed files with 47 additions and 45 deletions

View File

@ -6,7 +6,7 @@
## `DATE65.SYSTEM` ## `DATE65.SYSTEM`
*Run using Open Apple-D in `EMAIL.SYSTEM`* *Run using `Open Apple`-`D` in `EMAIL.SYSTEM`*
<p align="center"><img src="img/DATE65.jpg" alt="POP65" height="400px"></p> <p align="center"><img src="img/DATE65.jpg" alt="POP65" height="400px"></p>
@ -27,7 +27,7 @@ The first line is for Standard Time (ie: winter time). This has an offset of -1
The Daylight Saving Time rules are hard coded in `date65.c` using the current North American rules. The code will have to edited if you wish to implement Daylight Saving Time rules for any other area of the world. The Daylight Saving Time rules are hard coded in `date65.c` using the current North American rules. The code will have to edited if you wish to implement Daylight Saving Time rules for any other area of the world.
When `DATE65.SYSTEM` is run (either directly or using the Open Apple-D shortcut in `EMAIL.SYSTEM`) it will: When `DATE65.SYSTEM` is run (either directly or using the `Open Apple`-`D` shortcut in `EMAIL.SYSTEM`) it will:
- Show the current ProDOS date and time (or `---------- --:--` if it is not set.) - Show the current ProDOS date and time (or `---------- --:--` if it is not set.)
- Obtain the current UTC time using NTP server `pool.ntp.org` - Obtain the current UTC time using NTP server `pool.ntp.org`

View File

@ -8,7 +8,7 @@
*Automatically invoked when using W)rite, F)orward or R)eply in `EMAIL.SYSTEM`* *Automatically invoked when using W)rite, F)orward or R)eply in `EMAIL.SYSTEM`*
*Run manually using Open Apple-E in `EMAIL.SYSTEM`* *Run manually using `Open Apple`-`E` in `EMAIL.SYSTEM`*
`EDIT.SYSTEM` is a simple full-screen editor. It uses Apple //e auxiliary memory to store the text buffer, allowing files up to 46KB to be edited. The command keys are similar to the popular AppleWorks word processor. `EDIT.SYSTEM` is a simple full-screen editor. It uses Apple //e auxiliary memory to store the text buffer, allowing files up to 46KB to be edited. The command keys are similar to the popular AppleWorks word processor.

View File

@ -29,12 +29,14 @@ The rest of the line shows the From, Date and Subject headers of the message.
### Online Help ### Online Help
The command Open Apple-? will show the help screen, with a summary of all the keyboard commands: The command `Open Apple`-? will show the help screen, with a summary of all the keyboard commands:
<p align="center"><img src="img/email-help.png" alt="Email Help Screen" height="400px"></p> <p align="center"><img src="img/email-help.png" alt="Email Help Screen" height="400px"></p>
### Main Menu Commands ### Main Menu Commands
`EMAIL.SYSTEM` uses single character commands for most functions. Commands that involve invoking other helper applications use either the `Open Apple` or `Closed Apple` key as a modifier. The `Open Apple` key modifier is used for invoking helper applications that handle email, while the `Closed Apple` key is used for operations related to Usenet news.
- Message Summary Screen: - Message Summary Screen:
- Up arrow / `K` - Move the selection to the previous message. If this is the first message on the summary screen but this is not the first page, then load the previous page of messages and select the last item. - Up arrow / `K` - Move the selection to the previous message. If this is the first message on the summary screen but this is not the first page, then load the previous page of messages and select the last item.
- Down arrow / `J` - Move the selection to the next message. If this is the last message on the summary screen but there are further messages on subsequent pages, then load the next page of messages and select the first item. - Down arrow / `J` - Move the selection to the next message. If this is the last message on the summary screen but there are further messages on subsequent pages, then load the next page of messages and select the first item.
@ -60,16 +62,16 @@ The command Open Apple-? will show the help screen, with a summary of all the ke
- `F` - Forward current message - Prepare a forwarded copy of the selected email and place it in `OUTBOX` ready for editing. - `F` - Forward current message - Prepare a forwarded copy of the selected email and place it in `OUTBOX` ready for editing.
- News Article Composition: - News Article Composition:
- Closed Apple-`P` - Post news article - Prepare a new news article. - `Closed Apple`-`P` - Post news article - Prepare a new news article.
- Closed Apple-`F` - Post a follow-up - Prepares a new news article following up on the currently selected news article. - `Closed Apple`-`F` - Post a follow-up - Prepares a new news article following up on the currently selected news article.
- emai//er Suite: - emai//er Suite:
- Open Apple+`D` - Run `DATE65.SYSTEM` to set the system date using NTP (if you don't have a real time clock.) - `Open Apple`+`D` - Run `DATE65.SYSTEM` to set the system date using NTP (if you don't have a real time clock.)
- Open Apple+`R` - Run `POP65.SYSTEM` to retreive messages from email server. - `Open Apple`+`R` - Run `POP65.SYSTEM` to retreive messages from email server.
- Open Apple+`S` - Run `SMTP65.SYSTEM` to send any messages in `OUTBOX` to the email server. - `Open Apple`+`S` - Run `SMTP65.SYSTEM` to send any messages in `OUTBOX` to the email server.
- Open Apple+`E` - Edit message in `EDIT.SYSTEM`. From `EDIT.SYSTEM` `Open Apple`-`Q` will return you to `EMAIL.SYSTEM`. The message is opened in read-only mode to prevent accidental corruption of stored messages. If you want to save your changes, first choose a new file name using the `Open Apple`-`N` command in `EDIT.SYSTEM`, the `Open Apple`-`S` to save. - `Open Apple`+`E` - Edit message in `EDIT.SYSTEM`. From `EDIT.SYSTEM` `Open Apple`-`Q` will return you to `EMAIL.SYSTEM`. The message is opened in read-only mode to prevent accidental corruption of stored messages. If you want to save your changes, first choose a new file name using the `Open Apple`-`N` command in `EDIT.SYSTEM`, the `Open Apple`-`S` to save.
- Closed Apple+`R` - Run `NNTP65.SYSTEM` to retreive news articles from news server. - `Closed Apple`+`R` - Run `NNTP65.SYSTEM` to retreive news articles from news server.
- Closed Apple+`S` - Run `NNTP65UP.SYSTEM` to send any news articles in `NEWS.OUTBOX` to the news server. - `Closed Apple`+`S` - Run `NNTP65UP.SYSTEM` to send any news articles in `NEWS.OUTBOX` to the news server.
### Integrated Environment ### Integrated Environment

View File

@ -13,10 +13,10 @@ The system configuration file is called `EMAIL.CFG`. It is a straightforward Pr
To edit the file using `EDIT.SYSTEM`: To edit the file using `EDIT.SYSTEM`:
- Run `EDIT.SYSTEM` using Bitsy Bye or your usual ProDOS launcher. - Run `EDIT.SYSTEM` using Bitsy Bye or your usual ProDOS launcher.
- Press Open Apple-O to open a file, then enter `EMAIL.CFG` at the prompt, followed by return. - Press `Open Apple`-O to open a file, then enter `EMAIL.CFG` at the prompt, followed by return.
- Editing is fairly intuitive. Use the arrow keys to move around and type to insert text. Open Apple-Delete deletes to the right. - Editing is fairly intuitive. Use the arrow keys to move around and type to insert text. `Open Apple`-`Delete` deletes to the right.
- When you are satisfied, save the file using Open Apple-S. - When you are satisfied, save the file using `Open Apple`-`S`.
- Quit the editor using Open Apple-Q. - Quit the editor using `Open Apple`-`Q`.
All three of the mail programs `POP65.SYSTEM`, `EMAIL.SYSTEM` and `SMTP65.SYSTEM` share this configuration file. All three of the mail programs `POP65.SYSTEM`, `EMAIL.SYSTEM` and `SMTP65.SYSTEM` share this configuration file.

View File

@ -6,7 +6,7 @@
## `NNTP65.SYSTEM` ## `NNTP65.SYSTEM`
*Run using Closed Apple-R in `EMAIL.SYSTEM`* *Run using `Closed Apple`-`R` in `EMAIL.SYSTEM`*
[Back to Main emai//er Docs](README-emailler.md#detailed-documentation-for-usenet-functions) [Back to Main emai//er Docs](README-emailler.md#detailed-documentation-for-usenet-functions)

View File

@ -6,7 +6,7 @@
## `NNTP65UP.SYSTEM` ## `NNTP65UP.SYSTEM`
*Run using Closed Apple-S in `EMAIL.SYSTEM`* *Run using `Closed Apple`-`S` in `EMAIL.SYSTEM`*
[Back to Main emai//er Docs](README-emailler.md#detailed-documentation-for-usenet-functions) [Back to Main emai//er Docs](README-emailler.md#detailed-documentation-for-usenet-functions)

View File

@ -6,7 +6,7 @@
## `POP65.SYSTEM` ## `POP65.SYSTEM`
*Run using Open Apple-R in `EMAIL.SYSTEM`* *Run using `Open Apple`-`R` in `EMAIL.SYSTEM`*
<p align="center"><img src="img/POP65.jpg" alt="POP65" height="400px"></p> <p align="center"><img src="img/POP65.jpg" alt="POP65" height="400px"></p>

View File

@ -6,7 +6,7 @@
## `SMTP65.SYSTEM` ## `SMTP65.SYSTEM`
*Run using Open Apple-S in `EMAIL.SYSTEM`* *Run using `Open Apple`-`S` in `EMAIL.SYSTEM`*
<p align="center"><img src="img/SMTP65.jpg" alt="SMTP65" height="400px"></p> <p align="center"><img src="img/SMTP65.jpg" alt="SMTP65" height="400px"></p>

View File

@ -13,10 +13,10 @@ The news configuration file is called `NEWS.CFG`. It is a straightforward ProDO
To edit the file using `EDIT.SYSTEM`: To edit the file using `EDIT.SYSTEM`:
- Run `EDIT.SYSTEM` using Bitsy Bye or your usual ProDOS launcher. - Run `EDIT.SYSTEM` using Bitsy Bye or your usual ProDOS launcher.
- Press Open Apple-O to open a file, then enter `NEWS.CFG` at the prompt, followed by return. - Press `Open Apple`-`O` to open a file, then enter `NEWS.CFG` at the prompt, followed by return.
- Editing is fairly intuitive. Use the arrow keys to move around and type to insert text. Open Apple-Delete deletes to the right. - Editing is fairly intuitive. Use the arrow keys to move around and type to insert text. `Open Apple`-`Delete` deletes to the right.
- When you are satisfied, save the file using Open Apple-S. - When you are satisfied, save the file using `Open Apple`-`S`.
- Quit the editor using Open Apple-Q. - Quit the editor using `Open Apple`-`Q`.
All three of the programs that handle news: `EMAIL.SYSTEM`, `NNTP65.SYSTEM` and `NNTP65UP.SYSTEM` share this configuration file. All three of the programs that handle news: `EMAIL.SYSTEM`, `NNTP65.SYSTEM` and `NNTP65UP.SYSTEM` share this configuration file.

View File

@ -10,7 +10,7 @@ Suppose you want to subscribe to newsgroup `comp.sys.pdp11`.
1) Add a new line to `/H1/DOCUMENTS/EMAIL/NEWSGROUPS.CFG` as follows: `alt.sys.pdp11 ASP11 0` 1) Add a new line to `/H1/DOCUMENTS/EMAIL/NEWSGROUPS.CFG` as follows: `alt.sys.pdp11 ASP11 0`
2) Run `EMAIL.SYSTEM` and using `N)ew` command to create mailbox `ASP11`, matching the line in `NEWSGROUPS.CFG`. You may use any name you choose. 2) Run `EMAIL.SYSTEM` and using `N)ew` command to create mailbox `ASP11`, matching the line in `NEWSGROUPS.CFG`. You may use any name you choose.
3) Use the Closed Apple-R command to run `NNTP65.SYSTEM` and retreive messages from the newly-subscribed newsgroup. 3) Use the `Closed Apple`-`R` command to run `NNTP65.SYSTEM` and retreive messages from the newly-subscribed newsgroup.
When the 'last message' field of the newgroup is zero, `NNTP65.SYSTEM` will download the most recent 100 articles from the newsgroup. It will then set the most recent article counter in `NEWSGROUPS.CFG` so that subsequent runs will retrieve new messages only. When the 'last message' field of the newgroup is zero, `NNTP65.SYSTEM` will download the most recent 100 articles from the newsgroup. It will then set the most recent article counter in `NEWSGROUPS.CFG` so that subsequent runs will retrieve new messages only.

View File

@ -1,24 +1,24 @@
------------------------------------------+------------------------------------- ------------------------------------------+-------------------------------------
Message Summary Screen | Message Pager Message Summary Screen | Message Pager
[Up] / K Previous message | [Space] Page forward [Up] / K Previous message | [Space] Page forward
[Down] / J Next message | B Page back [Down] / J Next message | B Page back
[Space] / [Ret] Read current message | T Go to top [Space] / [Ret] Read current message | T Go to top
Q Quit to ProDOS | M MIME mode > Sort newest last | M MIME mode
------------------------------------------+ H Show email headers < Sort newest first | H Show email headers
Message Management | Q Return to summary Q Quit to ProDOS | Q Return to summary
S Switch mailbox +-------------------------------------
N Create new mailbox | emai//er Suite
T Tag current message | {-D Set date using DATE65 (NTP)
A Archive current/tagged message | {-R Receive email using POP65
C Copy current/tagged message | {-S Send OUTBOX using SMTP65
M Move current/tagged message | {-E Open current message in EDIT
D Mark current message deleted | }-R Receive news using NNTP65
U Remove deletion mark | }-S Sent NEWS.OUTBOX with NNTP65UP
P Purge messages marked as deleted |
------------------------------------------+------------------------------------- ------------------------------------------+-------------------------------------
Email Composition | News Composition Message Management | emai//er Suite
W Write an email message | }-P Post news article S Switch mailbox | {-D Set date using DATE65 (NTP)
R Reply to current message | }-F Follow-up to current article N Create new mailbox | {-R Receive email using POP65
F Forward current message | T Tag current message | {-S Send OUTBOX using SMTP65
------------------------------------------+------------------------------------- A Archive current/tagged message | {-E Open current message in EDIT
[ Any Key to Exit Help ] C Copy current/tagged message | }-R Receive news using NNTP65
M Move current/tagged message | }-S Sent NEWS.OUTBOX with NNTP65UP
D Mark current message deleted |
U Remove deletion mark +-------------------------------------
P Purge messages marked as deleted | News Composition
------------------------------------------| }-P Post news article
Email Composition | }-F Follow-up to current article
W Write an email message |
R Reply to current message +-------------------------------------
F Forward current message | [ Any Key to Exit Help ]

Binary file not shown.

Before

Width:  |  Height:  |  Size: 31 KiB

After

Width:  |  Height:  |  Size: 30 KiB