SOLAR v0.95.3 slrcmd <> SLRCMD.DOC

The SOLAR program slrcmd.exe is called by the Solar System to process
SOUP format COMMANDS files contained in a SOUP packet. Supported commands
include:

        subscribe
        unsubscribe
        list
        mail
        deletemail
        newsindex
        mailtype

These commands are generally placed in the COMMANDS file by some type
of SOUP compliant offline newsreader. See the specifications for SOUP
v1.2 for more information regarding command syntax.

--
Command Line Syntax:

  slrcmd /u username [/v]

    /u username             : The user's login name. Required.
    /v                      : Turn verbose mode on.

  Command line switches may be upper case or lower case. Whitespace
  need not be used for the username (i.e. /uusername also works).

--
Installation:

  Under normal operations, when using Solar as a complete system
  underneath Waffle, slrcmd will be called as needed by the other Solar
  programs. Solar expects to find slrcmd.exe in Solar's home directory.

    File location:

    In Solar's configuration file, the 'solarpath' parameter points to
    Solar's home directory. Slrcmd.exe must reside in that directory
    for the remainder of the Solar System to find it.

  Slrcmd loads configuration parameters from Waffle's static file, the
  Solar configuration file, and from the user's configuration file, if
  one exists. The location of Waffle's static file comes from the WAFFLE
  environment variable. The location of Solar's configuration file comes
  from either a 'solar:' parameter in Waffle's static file or a SOLAR
  environment variable, in that order. The user's configuration file is
  found through the 'user:' parameter in Waffle's static file, the
  username from the command line, and the filename OPTIONS.SLR.

    Environment variables:

    WAFFLE=c:\waffle\system\static
      - An entry in this file may point to Solar's configuration
        file (i.e. solar : c:\waffle\solar\solar.cfg)

    SOLAR=c:\waffle\solar\solar.cfg
      - This is another way to provide the location of Solar's
        configuration file. Only one method is required.

  Slrcmd uses the following parameters from Waffle's static file.
  All of the listed parameters must be present for slrcmd to work.

    user      - Path to root of user directories. This is combined
                with the username from the command line to find the
                user's directory.

    temporary - Path to temporary directory. Since Solar expects to
                have exclusive use of it's own temporary directory,
                relying on this parameter is a bad idea. The 'solarwork'
                parameter in Solar's configuration file overrides the
                value of 'temporary' and is preferred.

    waffle    - Path to the root of your Waffle software directory tree.

    solar     - Path to Solar's configuration file. (optional, see above)

  Slrcmd uses the following parameters from Solar's configuration
  file.

     solarwork - Path to Solar's temporary directory. This value
                overrides the 'temporary' parameter from Waffle's
                static file. The use of 'solarwork' is recommended
                since Solar expects to have exclusive use of it's
                own temporary directory. However, this parameter
                is optional.

     mail-type - Default SOUP mail message type. This parameter can
                only be set to "m" or "M" in this release of Solar.
                Future releases may support other SOUP mail message
                formats. Without this parameter, slrmail defaults
                to SOUP mail message type "m". See the SOUP 1.2
                specification for details on mail message formats.


  Slrmail uses the following parameters from the user's OPTIONS.SLR
  file.

     mail-index - SOUP index file format for mail messages. This
                parameter can only be set to "n" in this release of
                Solar. Future releases may support other SOUP index file
                formats. Without this parameter, slrmail will default
                mail-index to "n". See the SOUP 1.2 specification for
                details on index file formats.

     mail-type - SOUP mail message type. This parameter can only be set
                to "m" or "M" in this release of Solar. Future releases
                may support other SOUP mail message formats. Without
                this parameter, slrmail defaults to SOUP mail message
                type "m". See the SOUP 1.2 specification for details on
                mail message formats.

