@database "IPop.guide"
@master "IPop.guide"
@author Deryk Robosson
@(c) "Copyright © 1999 Deryk B. Robosson"
@$VER: IPop.guide 1.0 (13.10.99)
@wordwrap
@index Main

@node Main "Index"

                                   IPop
                         The Internet POP AppIcon
                    Copyright 1999 by Deryk B. Robosson

                               @{"Introduction" LINK "Introduction"}
                                   @{"Usage" LINK "Usage"}
                                 @{"ToolTypes" LINK "Tooltypes"}
                                @{"CLI Options" LINK "CLIOptions"}
                              @{"ARexx Commands" LINK "ARexxCommands"}
                                  @{"Author" LINK "Author"}

NOTE: The SPOOL option does work but you won't get headers. This is a
      limitation of aml.library at the moment and we will hopefully get
      this taken care of so it can spool & parse article headers at the
      same time.

@endnode

@node Introduction "Introduction"
  IPop was written mainly as an exercise in learning the API for the new
AmigaOS3.5 aml.library API.  After the initial POP code was written, it was
encapsulated by Olaf Barthel's ClockIcon AppIcon source and grew from there.
@endnode

@node Usage "Usage"

  IPop can be ran easily from either the Workbench or command line.  When
ran from Workbench it will initialize and wait to check your account. IPop
does not detach itself from a shell console so you may wish to 'run' it
instead.

Forcing a check:
  Double clicking on the AppIcon will cause IPop to instantly check your
account.

  Selecting the AppIcon (single left click) and then selecting Open from the
Workbench Icon menu will also perform this check.

Header Information:
  Selecting the AppIcon (single left click) and then selecting Information
from the Workbench Icon menu will open the Headers window which will list
all mail headers (From and Subject lines) currently waiting.

  This can also be achieved by using a commodity tool such as Exchange by
selecting the Show Interface (Hide Interface will close the window).
@endnode

@node RxAuthor "RxAUTHOR"
IPop/AUTHOR                                                       IPop/AUTHOR
  NAME
     AUTHOR

  SYNOPSIS
     result = AUTHOR

  FUNCTION
     returns the author information

  INPUTS
     none

  RESULT
     result - returns the author string of IPopCx
@endnode

@node RxCHECK "RxCHECK"
IPop/CHECK                                                         IPop/CHECK

  NAME
     CHECK TIME/N

  SYNOPSIS
     void = QUIT

  FUNCTION
     Sets the check time, or forces a pop check.

  INPUTS
     TIME = sets time in minutes between pop intervals
     none = force pop check

  RESULT
     none
@endnode

@node RxQUIET "RxQUIET"
IPop/QUIET                                                         IPop/QUIET

  NAME
     QUIET

  SYNOPSIS
     result = QUIET

  FUNCTION
     Toggles the pop window

  INPUTS
     none

  RESULT
     result - 0 enabled, 1 disabled
@endnode

@node RxQUIT "RxQUIT"
IPop/QUIT                                                           IPop/QUIT

  NAME
     QUIT

  SYNOPSIS
     void = QUIT

  FUNCTION
     quits the application

  INPUTS
     none

  RESULT
     none
@endnode

@node RxVersion "RxVERSION"
IPop/VERSION                                                     IPop/VERSION
  NAME
     VERSION

  SYNOPSIS
     result = VERSION

  FUNCTION
     returns the version string

  INPUTS
     none

  RESULT
     result - returns the version string of IPop
@endnode

@node RxWAITING "RxWAITING"
IPop/WAITING                                                     IPop/WAITING

  NAME
     WAITING

  SYNOPSIS
     RC = WAITING

  FUNCTION
     Returns the number of waiting messages.

  INPUTS
     none

  RESULT
     result = number of waiting messages
@endnode

@node Tooltypes "Tooltypes"
SERVER            Name of your POP server (required)
PORT              Port number (default: 110)
USERNAME          Username for the POP account (required)
PASSWORD          Password for the POP account (required)
TIME              Interval in minutes to check (default: 10 minutes)
QUIET             Supresses the status window (default: NO)
REXXPORT          ARexx port name to use (default: IPOP.1)
CX_PRIORITY       Commodity Priority (default: 0)
CX_POPKEY         Commodity Popkey (default: control alt i)
SPOOL             Spool filename (default: none)

NOTE: CX_POPUP is not supported as it would be really kinda silly to have
      an empty header window open on startup.
@endnode

@node CLIOptions "CLI Options"
SERVER/A          Name of your POP server (required)
PORT/N/K          Port number (default: 110)
USERNAME/A        Username for the POP account (required)
PASSWORD/A        Password for the POP account (required)
TIME/N/K          Interval in minutes to check (default: 10 minutes)
QUIET/S           Supresses the status window
REXXPORT/K        ARexx port name to use (default: IPOP.1)
CX_PRIORITY/N/K   Commodity Priority (default: 0)
CX_POPKEY/K       Commodity Popkey (default: control alt i)
SPOOL/K           Spool filename (default: none)
@endnode

@node ARexxCommands "ARexx Commands"

@{"AUTHOR" LINK "RxAuthor"}   Returns the author information
@{"CHECK" LINK "RxCHECK"}    Sets the check time or forces a pop check.
@{"QUIET" LINK "RxQUIET"}    Toggles the Status window
@{"QUIT" LINK "RxQUIT"}     Exits the application
@{"VERSION" LINK "RxVersion"}  Returns the current version of IPop
@{"WAITING" LINK "RxWAITING"}  Returns the number of waiting messages

@endnode

@node Author "Author"

I can be reached usually at the following:

Snail mail:
Deryk Robosson
8 McKeown Ave
Albany, Western Australia 6330
Australia


Electronically:
URL: http://linux.tc3net.com/newlook/
EMAIL: newlook@linux.tc3net.com
IRC: irc.amiganet.org on channel #amiga (nick of newlook)

Updates and such will be posted always to my web site and not Aminet.
@endnode