@DATABASE SongPlayerCLI.guide
@AUTHOR "Gareth Griffiths"
@VERSION 1.52
@WORDWRAP
@NODE MAIN "SongPlayerCLI - Main Menu"

   @{B}SongPlayerCLI.
   Version 1.52 (16-04-2000)
   By Gareth Griffiths (gazchap@btinternet.com)


   Main Menu@{UB}

   @{" Introduction           " LINK Introduction}
   @{" About The Author       " LINK About_The_Author}
   @{" Legal Stuff            " LINK Legal_Stuff}

   @{" Requirements           " LINK Requirements}
   @{" Installation           " LINK Installation}
   @{" Usage                  " LINK Usage}

   @{" History                " LINK History}
   @{" Credits                " LINK Credits}
   @{" Greetz                 " LINK Greetz}

   @{" Final Word(s)          " LINK Final_Words}

   * SongPlayerCLI is @{B}MAILWARE@{UB}. Please e.mail me if you use it! *
   
@ENDNODE

@NODE INTRODUCTION "SongPlayerCLI - Introduction"

   @{B}SongPlayerCLI.
   Version 1.52 (16-04-2000)
   By Gareth Griffiths (gazchap@btinternet.com)


   Introduction@{UB}

   This utility is a simple means of controlling SongPlayer via the CLI
   (or Shell). If you have SongPlayer installed on your system, then you
   can use this utility straight after installation. If however you do
   not have SongPlayer, you will have to install it. It can be found on
   most recent Amiga Format CD-ROMs, and on AmiNET.

   SongPlayer by Stephane TAVENARD is a powerful utility for playing sound
   files, and supports most sound formats. This utility is designed to help
   you play MP3s (MPEG1-III) in your playlist, but can be used to play 
   any sound files in the playlist.

   After installation, you can then control your version of SongPlayer via
   the CLI interface, be it one you have started from Workbench, or the
   standard AmigaDOS window you get when you boot with no startup sequence
   (this is the intended use). 

   I hope you find this utility useful. I know I do! I am always booting
   from no startup sequence, because I am starting to like the CLI more
   than my Magellan 2 Workbench!! (shock! horror!)
  
   Gareth Griffiths.

@ENDNODE

@NODE ABOUT_THE_AUTHOR "SongPlayerCLI - About The Author"

   @{B}SongPlayerCLI.
   Version 1.52 (16-04-2000)
   By Gareth Griffiths (gazchap@btinternet.com)


   About The Author@{UB}

   Well, I'm 16 years old, and I live in Shrewsbury in the UK. There is 
   a photograph of me in the archive, named Author.jpg (it is a JPEG file
   so you will need a suitable viewer to look at it) and whilst I may not
   be the best looking guy in the world, it don't matter, 'cos looks don't
   mean shit, it's personality that counts in my book!! And everyone tells
   me that I have a great one of those, with a good sense of humour etc.
   etc. Indeed, some people even think I have a sexy voice!!! :o)

   I got my first Amiga (the A1200 I have now) in 1994, and started
   upgrading it in 1996. The first upgrade was a 772Mb hard drive and an
   8Mb RAM board, from Gasteiner. The 8Mb RAM was soon limiting however,
   so I persuaded a mate to buy me a 68030 accelerator board from Eyetech. 
   It came with two SIMM sockets, so I filled them up with 8Mb each, giving
   me 16Mb RAM. Nice!! 

   However, the power of the '030 wasn't enough either, so earlier this 
   year I upgraded to a Blizzard 1260 Turbo board. The 68060 processor is
   shit-hot and my Amiga is faster than ever. And I like it!!!

   I still have the 16Mb RAM, although I am trying to find a 32Mb SIMM for
   cheap. My next upgrade will probably be a tower followed by a PPC board.
   Then I will get a graphics card, so that I can view large files without
   Workbench taking up all of my fucking Chip RAM :o(

   *  Apologies for any bad language in this documentation file. I could
      easily edit it out, but what the fuck happened to free speech? :o)

   *  If you want to contact me, e.mail me at kgrandpa@yahoo.com

@ENDNODE

@NODE LEGAL_STUFF "SongPlayerCLI - Legal Stuff"

   @{B}SongPlayerCLI.
   Version 1.52 (16-04-2000)
   By Gareth Griffiths (gazchap@btinternet.com)


   Legal Stuff@{UB}
   
   This software is MAILWARE. If you use it regularly, please e.mail the
   author at @{FG HIGHLIGHT}gazchap@btinternet.com@{FG TEXT} and let him
   know. You will then be classed as a registered user and will receive
   updates before they are uploaded to Aminet. Please include your
   e.mail address and system specs in your registration e.mail.
   
   This software has been thoroughly checked with a virus checker and has
   proven to be clean of viruses. However, this means nothing in the big
   bad world of the Internet. Virii can creep in anywhere, so it is usually
   a good idea to pass all files you download from the Internet through a
   virus checker just to make sure. I will not be held responsible for any
   damage done to you or your system from a virus transmitted through this
   software. The file I uploaded to Aminet was clean of viruses, and any
   future files I upload to Aminet will also be clean, so use Aminet as
   your source for safe files!!
   
   You can copy and distribute this software as much as you want, as long
   as you do not modify the distribution archive, that means you cannot
   add files or remove files in the archive, nor can you modify any files
   that are in the archive.
   
   I grant permission for this software to be distributed on cover CD's
   or disks, but would ask that the magazine publishers send me a copy
   of the magazine as a form of 'payment' if you like.
   
   You can store this software on your own web space, but please e.mail
   me the link so I can check it out! Thanks!
   
   If you find any bugs in the software, please notify me using the address
   above. They will then be fixed as soon as possible. Thanks.
   
@ENDNODE

@NODE REQUIREMENTS "SongPlayerCLI - Requirements"

   @{B}SongPlayerCLI.
   Version 1.52 (16-04-2000)
   By Gareth Griffiths (gazchap@btinternet.com)


   Requirements@{UB}

   To make good use of the SongPlayer CLI Controller you will need:-

      ·  An Amiga (durrrrr)

      ·  A version of Workbench with RexxMast installed and running.
      
      ·  rexxreqtools.library in your LIBS: directory (not included)
         Search for RexxReqTools.lha on Aminet. It should be in util/rexx

      ·  Magic User Interface (not actually needed for this, but 
         SongPlayer itself uses it.)

      ·  SongPlayer (only tested on v1.53, send me your version if it
         works!)

      ·  A Shell/CLI (should have come either in ROM or with Workbench)

      ·  Some sound files/playlists to use it with!!!

   A mouse isn't particularly required unless you want to control
   SongPlayer with it, but that would defeat the object of using this
   program, would it not?

@ENDNODE 

@NODE INSTALLATION "SongPlayerCLI - Installation"

   @{B}SongPlayerCLI.
   Version 1.52 (16-04-2000)
   By Gareth Griffiths (gazchap@btinternet.com)


   Installation@{UB}

   At the moment it is only possible to install the CLI controller manually
   but I am busy working on an Installer script to do the job for you.
   keep an eye open for updates!

   To install the software manually, follow these instructions:-

      ·  Copy all files from the Rexx directory of the archive into your
               REXX: assign. Keep the SpCLI directory structure!!. 

      ·  Copy these files somewhere into your system path (C: is good):-

            ·  RunSongPlayer
            ·  SpCLI
      
      ·  Edit the RunSongPlayer text file so that it points to your
         SongPlayer executable. For example, by default the file contains:-

            Run >NIL: C:SongPlayer

         But if your SongPlayer was contained in Tools: you would change it to:-

            Run >NIL: Tools:SongPlayer

         And then save the file and exit.

      ·  If they are not already set, make sure both the files have their
         S protection bit set. To do this, go to a CLI window and type:-

            Protect RunSongPlayer +SRWED <RETURN>
            Protect SpCLI +SRWED <RETURN>

      ·  Installation complete! See the @{"Usage" LINK Usage} section now!

@ENDNODE

@NODE USAGE "SongPlayerCLI - Usage"

   @{B}SongPlayerCLI.
   Version 1.52 (16-04-2000)
   By Gareth Griffiths (gazchap@btinternet.com)


   Usage@{UB}

   Making use of the program couldn't be simpler. The 'SpCLI' file you 
   copied during installation is the core of the program. Go to a CLI
   and type 'SpCLI help' and you should be presented with a list of the
   commands.

   Here is the list of commands (some are linked, as they need further
   explanation):-

       PLAY        - Plays the current file.
       STOP        - Stops the current file.

      @{" ADD      " LINK CMD_Add}  - Adds a file to the playlist.
       FIRST       - Selects the first file in the playlist.
       PREV        - Selects the previous file in the playlist.
       NEXT        - Selects the next file in the playlist.
       LAST        - Selects the last file in the playlist.
       RANDOM      - Selects a random file from the playlist.
      @{" SELECT   " LINK CMD_Select}  - Allows you to select a file based on its ID.
      @{" FIND     " LINK CMD_Find}  - Prompts you for a search string to find a title.

       COUNT       - Counts the number of files in the playlist.
       INFO        - Gives information on the current file.
       LIST        - Outputs a list of all files in the playlist.

       SHOW        - Shows the SongPlayer interface.
       HIDE        - Hides the SongPlayer interface.
       QUIT        - Exits SongPlayer completely.

      @{" HELP     " LINK CMD_Help}  - Displays the help text.

@ENDNODE

@NODE CMD_Add "SongPlayerCLI - Add"

   @{B}SongPlayerCLI.
   Version 1.52 (16-04-2000)
   By Gareth Griffiths (gazchap@btinternet.com)


   Command: ADD <path>@{UB}

     The ADD command allows you to add new files to the end of the current
     playlist.

     You can either enter the filepath directly in the command, or leave
     it blank and a file requester will pop up.

     For example, I could type:
     
          SpCLI ADD DH3:Music/LockNLoad_BlowYaMind.mp3

     And then that file would be added to the end of the playlist, and
     SongPlayer would automatically play it.

@ENDNODE

@NODE CMD_Select "SongPlayerCLI - Select"

   @{B}SongPlayerCLI.
   Version 1.52 (16-04-2000)
   By Gareth Griffiths (gazchap@btinternet.com)


   Command: SELECT <id>@{UB}

   This command enables you to select a specific file in the playlist.
   Pass the ID number as parameter <id> and it will automatically jump
   to that file. If you leave <id> blank, you are prompted.

   But how do I get the ID numbers???

   Simple! There are two commands that give out ID numbers, LIST and @{"FIND" LINK CMD_Find}.
   LIST just outputs a list of all of the files in the playlist, preceded
   by a number. For example:-

      @{B}·  (1) Travis: Turn
      ·  (2) Alice Deejay: Back In My Life
      ·  (3) Eminem: Brain Damage
      (etc. etc.)@{UB}

   So, if you wanted to select 'Brain Damage' as the file to play, you would
   enter '3' at the prompt (minus the quotes) Like so:-
   
      @{B}Enter ID Number: 3
      Current File: (3) Eminem: Brain Damage@{UB}

   There ya go! @{"FIND" LINK CMD_Find} does much the same thing, but allows
   for more specific searches. See its page for more information.

@ENDNODE

@NODE CMD_Find "SongPlayerCLI - Find"

   @{B}SongPlayerCLI.
   Version 1.52 (16-04-2000)
   By Gareth Griffiths (gazchap@btinternet.com)


   Command: FIND <string>@{UB}

   The FIND command allows you to search through the TITLES of your playlist
   files for a specified string. You can either pass this string directly
   as a parameter, e.g.:
   
      SpCLI FIND "Brain"   - don't forget those quotes!
      
   or you can leave it blank and the program will prompt you for a search
   string. Using the "Brain" example above, if my playlist looked like this:

      @{B}·  (1) Travis: Turn
      ·  (2) Alice Deejay: Back In My Life
      ·  (3) Eminem: Brain Damage
      ·  (4) Wamdue Project: King Of My Castle
      ·  (5) REM: Shiny Happy People
      ·  (6) Lou Bega: Mambo Number Five
      ·  (7) The Prodigy: Smack My Bitch Up
      ·  (8) Eminem: Just Don't Give A Fuck
      ·  (9) New Order: 1963@{UB}

   I would get this back in return:
      
         @{B}·  (3) Eminem: Brain Damage
      1 matche(s) found.@{UB} 

   Enabling me to use the @{"SELECT" LINK CMD_Select} command to jump 
   straight to that file! 

   Note that it does not search for whole words, it searches for occurences,
   so if I typed my search string as 'm' I would get this:-

      @{B}Enter search string: m
      
         ·  (2) Alice Deejay: Back In My Life
         ·  (3) Eminem: Brain Damage
         ·  (4) Wamdue Project: King Of My Castle
         ·  (6) Lou Bega: Mambo Number Five
         ·  (7) The Prodigy: Smack My Bitch Up
      5 matche(s) found.@{UB}

   Simple huh? :o)

@ENDNODE

@NODE CMD_Help "SongPlayerCLI - Help"

   @{B}SongPlayerCLI.
   Version 1.52 (16-04-2000)
   By Gareth Griffiths (gazchap@btinternet.com)


   Command: HELP <command>@{UB}

   This command gives you instant help on any command used by SpCLI. You
   can pass the command you are needing help with as a parameter, e.g:
   
      SpCLI HELP SELECT
      
   Which will display the help text for the SELECT command.
   
   Alternatively, you can leave <command> blank and a general help text
   will be displayed, containing brief help on all the commands.
   
@ENDNODE

@NODE HISTORY "SongPlayerCLI - History"

   @{B}SongPlayerCLI.
   Version 1.52 (16-04-2000)
   By Gareth Griffiths (gazchap@btinternet.com)


   History@{UB}

     Here is a relatively comprehensive history of the program.

     @{B}v1.52 (16-04-2000)@{UB}
     
        · Added argument passing to the ADD command.
        · Added argument passing to the FIND command.
        · Added argument passing to the SELECT command.
        · Added argument passing to the HELP command,
          now you can get HELP on any command at any time!
        
        · The ADD command now has a file requester!!
        
     @{B}v1.51 (15-04-2000)@{UB}
     
        · Implemented the ADD command.
        · Tidied up the ARexx scripts.
        · Made the output to the CLI more 'organised'

        · First public release.

     @{B}v1.49 (22-12-1999)@{UB}

        · Implemented the FIND command.
        · Implemented the SELECT command.
        · Implemented the RANDOM command.

     @{B}v1.4  (16-12-1999)@{UB}
          
        · Implemented the LIST command.
        · Fixed stupid bug in the NEXT command.
     
     @{B}v1.36 (09-12-1999)@{UB}
          
        · Implemented the COUNT command.
        · Implemented the INFO command.
     
     @{B}v1.3  (04-12-1999)@{UB}
               
        · Implemented the HIDE command.
        · Implemented the SHOW command.

     @{B}v1.2  (02-12-1999)@{UB}
               
        · Implemented the QUIT command.
        · Optimised the ARexx scripts a bit.

     @{B}v1.1  (27-11-1999)@{UB}

        · Implemented the FIRST command.
        · Implemented the LAST command.

     @{B}v1.0  (25-11-1999)@{UB}
     
        · Implemented the PLAY command.
        · Implemented the STOP command.
        · Implemented the NEXT command.
        · Implemented the PREV command.
          
        · First version, not released.

@ENDNODE

@NODE CREDITS "SongPlayerCLI - Credits"

   @{B}SongPlayerCLI.
   Version 1.52 (16-04-2000)
   By Gareth Griffiths (gazchap@btinternet.com)


   Credits

   SongPlayer CLI Controller@{UB}

      Gareth Griffiths (GazChap/JokerD)
      Web: http://www.gazchap.co.uk
      E.mail: gazchap@btinternet.com
      IRC: Auriga
      
   @{B}SongPlayer@{UB}
      
      Stéphane TAVENARD (ANGERS/France)
      Web: http://perso.wanadoo.fr/stephane.tavenard/
      E.mail: stephane.tavenard@wanadoo.fr
      IRC: Tatav

@ENDNODE

@NODE GREETZ "SongPlayerCLI - Greetz"

   @{B}SongPlayerCLI.
   Version 1.52 (16-04-2000)
   By Gareth Griffiths (gazchap@btinternet.com)


   Greetz@{UB}

   A big @{FG HIGHLIGHT}hello@{FG TEXT} to:-

      Boom^, Lockpick, YT2095, AmiMan^, ZimZum, Zorbo, Bingley,
      Horney Reaper 2000, Sweetie, Shex, operato, Cav, AmiGav, sTiLsKiN,
      StealthX, b0ing, SpiritX, ^GeiR, Tux^, ^L0KI^, LuCiFeR-S^D, Gadge,
      FantaProd, EcheXiO, MrFlibble, r!K, HotCakes, Kihl, and the rest 
      of the Satanic Dreams Software crew!

   Hugz and kissez to the following:-

      @{FG HIGHLIGHT}HoneyBear, Amy,@{FG TEXT} Fizzle, Nikki. :o)

   Really painful and slow Death to the following:-

      Jeeves.

@ENDNODE

@NODE FINAL_WORDS "SongPlayerCLI - Final Words"

   @{B}SongPlayerCLI.
   Version 1.52 (16-04-2000)
   By Gareth Griffiths (gazchap@btinternet.com)


   Final Word(s)@{UB}

   "The path of the righteous man is beset on all sides, by the inequities
   of the selfish,  and the tyranny of evil men. Blessed is he, who in the
   name of charity and goodwill,  shepherds the weak through the valley of
   darkness,  for he is truly his brother's keeper, and the finder of lost
   children.  And I will strike  down upon thee with  great vengance,  and 
   furious anger, those who attempt to poison and destroy my brothers. And
   you will know my name is the Lord, when I lay my vengeance upon thee."

   Ezekiel 25:17.
   Samuel L. Jackson, Pulp Fiction (1994)

@ENDNODE

@NODE NOTHING "SongPlayerCLI - Blank Page"
@ENDNODE