home *** CD-ROM | disk | FTP | other *** search
/ Beijing Paradise BBS Backup / PARADISE.ISO / software / BBSDOORW / LYRICS11.ZIP / LYRICS.DOC < prev    next >
Encoding:
Text File  |  1995-10-13  |  16.7 KB  |  484 lines
  1.  
  2.                                   <<<<<>>>>>
  3.                                     Lyrics
  4.                                   <<<<<>>>>>
  5.  
  6.                                  Version v1.1
  7.                                  ~~~~~~~~~~~~
  8.                      Copyright 1994,95 by Dominic Dupuis
  9.  
  10.                        Supports PCBoard, Wildcat!, Gap,
  11.                          RBBS, Spitfire, TriBBS, WWIV.
  12.  
  13.                              Released  10/13/1995
  14.  
  15.                                   Programmed
  16.                                       by
  17.                                 Dominic Dupuis
  18.  
  19.                      Official distribution site for Lyrics
  20.                            Le Microbe BBS (Beta Site)
  21.                               Sysop: Dave Mustaine
  22.                              -=> (819) 478-3643 <=-
  23.                                FREQ: LYRICS11.ZIP
  24.                               1200/2400/9600/14.4k
  25.                                   24 Hours/Day
  26.  
  27.  
  28. To contact me: - call on Le Microbe BBS and Email to my alias: Dave Mustaine
  29.                - my Internet E-Mail adress is: ddupuis@9bit.qc.ca
  30.                - or write to me:
  31.  
  32. Lyrics WWW Home Page is: "http://www.9bit.qc.ca/webusr/ddupuis/lyrics.html"
  33.  
  34. Dominic Dupuis
  35. 534 Henri-Dunant
  36. Drummondville, Québec
  37. J2C 3L9
  38.  
  39. You can also call to Le Microbe BBS with the log "LYRICS" (no password) and
  40. access the Lyrics door, the Lyrics files (LYRICSxx.ZIP and LYRUSRxx.ZIP)
  41. without any ratio. Up to now, when I wrote this doc, there was more than
  42. 6000 songs & tablatures in the Lyrics database.
  43.  
  44.  
  45. New Versions
  46. >>>>>>>>>>>>>
  47.  
  48. Please call Le Microbe BBS for the latest version of this program.
  49.  
  50. FREQ: LYRICS11.ZIP (Between 5h30am - 2h30am)
  51.       (819) 478-3643
  52.  
  53. You can also go by Internet to Lyrics WWW Home Page.
  54.  
  55.  
  56. Legalities
  57. >>>>>>>>>>>
  58.  
  59. This software claims no warranty, implied or otherwise.  This software
  60. is provided "AS IS".  The author claims no responsibility for any damages
  61. that might be caused by the use or abuse of this software.  This software
  62. remains the property of the author.  This software may not be modified in
  63. any way.
  64.  
  65. I am not responsible for copyrighted songs uploaded in Lyrics. If so, please
  66. tell the sysop to delete these songs.
  67.  
  68. =============================================================================
  69.                                  NOTICE
  70.  
  71.                  WARNING CONCERNING COPYRIGHT RESTRICTIONS
  72.  
  73. The copyright law of the United States (Title 17, United States Code)
  74. governs the making of photocopies or other reproductions of copyrighted
  75. material.
  76.  
  77. Under certain conditions specified in the law, libraries and archives
  78. are authorized to furnish a photocopy or other reproduction. One of
  79. these specified conditions is that the photocopy or reproduction is not
  80. to be "used for any purpose other than private study, scholarship, or
  81. research." If a user makes a request for, or later uses, a photocopy or
  82. reproduction for purposes in excess of "fair use," that user may be
  83. liable for copyright infringement.
  84.  
  85. This institution reserves the right to refuse to accept a copying order
  86. if, it its judgement, fulfillment of the order would involve violation
  87. of copyright law.
  88.  
  89. Many items in this archive do not contain individual copyright
  90. notices.  The lack of a notice does not necessarily mean than the work
  91. is not protected by copyright law.
  92. =============================================================================
  93.  
  94. Distribution
  95. >>>>>>>>>>>>>
  96.  
  97. You may upload and download this file to/from any BBS or any other
  98. distribution method as long as NO modification is made to the archive file
  99. (.ZIP) and its contents. Beyond a fee for the reproduction and media cost,
  100. no fee may be charged for distribution of this software.
  101.  
  102.  
  103. Features
  104. >>>>>>>>>
  105.  
  106.   * Desqview and OS/2 aware
  107.   * COM 1-15 support and non-standard IRQs
  108.   * Sysop chat function
  109.   * Return to BBS on dropped carrier
  110.   * Will timeout a player after 2 minutes of inactivity
  111.   * Support most BBS drop files
  112.   * Internet song file support
  113.   * Lempel-Ziv-Welch compression (LZW)
  114.   * OLGA (Online Guitar Archive from Internet) support
  115.     (mirror site: "http://www.guitar.net/olga/winolga/" )
  116.  
  117.  
  118. Included files
  119. >>>>>>>>>>>>>>>
  120.  
  121.     LYRICS.EXE    -=> The program itself
  122.     LYRICS.DOC    -=> Docs for installation (English, this file!)
  123.     LYRICS_F.DOC  -=> Docs for installation (French)
  124.     RUNDOOR.BAT   -=> Sample batch file
  125.     LYRICS2.CFG   -=> Sample config file
  126.     REGBBS.FRM    -=> Registration form ($5 only!)
  127.     LYRUSR11.ZIP  -=> DO NOT unzip this file in your Lyrics directory, it's
  128.                       only available for the users. DO NOT delete it either!
  129.  
  130.  
  131. Created files & directories
  132. >>>>>>>>>>>>>>>>>>>>>>>>>>>>
  133.  
  134.     LYRICS.NEW    -=> Last 400 uploaded songs
  135.     LYRICS.QTS    -=> Last 100 quotes
  136.     LYRICS.LOG    -=> Log file
  137.     LYRICS.USR    -=> User file (DO NOT delete this file!)
  138.     VERSION       -=> Version of Lyrics
  139.     IMPORT\       -=> Directory where files are uploaded
  140.     DATA\         -=> Directory where all the songs & tablatures are stored
  141.  
  142.  
  143. Installation
  144. >>>>>>>>>>>>>
  145.  
  146. Unzip the file LYRICSxx.ZIP in a directory.
  147.  
  148. You can create/edit a configuration file by running LYRICS without parameters
  149. or by using /C as parameter. (ie: LYRICS /C )
  150.  
  151. To run the door just type
  152.  
  153.   LYRICS <config file> [/F | /FA] [/M | /MF]
  154.  
  155. Example:  LYRICS LYRICS.CFG /F
  156.  
  157. Extra parameters:
  158.  
  159.      /M        :  If it's the 1st day of the month, execute the monthly
  160.                   maintenance, else it returns you to the prompt.
  161.      /MF       :  Force the execution of the maintenance.
  162.  
  163.      /FA       :  Run Lyrics in French by default
  164.      /F        :  Ask the language to the user (English or French)
  165.  
  166. NB: By default, Lyrics run in English.
  167.  
  168. NB: Add the line "lyrics lyrics.cfg /M" in your maintenance batch file. It's
  169.     *really* not necessary to execute the maintenance every day.
  170.  
  171. Lyrics will create all the necessary directories and files automatically.
  172. Lyrics requires about 307k of free memory to run properly.
  173.  
  174. For a REALLY faster execution of Lyrics, load Smartdrive (smartdrv).
  175.  
  176. WARNING: The door is not multi-node compatible. (For now...)
  177.  
  178. By the way, Lyrics will create a log file named LYRICS.LOG
  179.  
  180. You'll need to have a COMSPEC environment variable.
  181. For example: "set comspec=c:\dos\command.com"
  182.  
  183. ******************************************************************************
  184. * PKZIP,PKUNZIP and DSZ.EXE are NOT included with the LYRICS.EXE file, but   *
  185. * you must have those files within your PATH statement.                      *
  186. ******************************************************************************
  187.  
  188.  
  189. Configuration file
  190. >>>>>>>>>>>>>>>>>>>
  191.  
  192. In the configuration file, you need to write the following informations:
  193.  
  194.   Line 1:   Door data file type
  195.   Line 2:   Path to the door data file(s)  (with the trailing backslash "\")
  196.   Line 3:   BBS name
  197.   Line 4:   Sysop's name
  198.   Line 5:   Locked baud rate
  199.  
  200. As illustrated above, the door's data file type is specified in line 1
  201. and can be PCB for  PCBoard, GAP for GAP (DOOR.SYS), SF  for Spitfire,
  202. RBBS  for RBBS, WC for WildCat!, TRIBBS  for TriBBS, or WWIV for WWIV.
  203. The  locked baud rate  is specified in  line 5.   If the sysop doesn't
  204. lock his  serial port, he  must specify  0 for the  locked baud  rate.
  205.  
  206. Sample door configuration file
  207. -------------------------------
  208. GAP
  209. c:\sbbs\node1\
  210. Le Microbe
  211. Dave Mustaine
  212. 38400
  213. -------------------------------
  214.  
  215. You can run the door locally by specifying /L after the configuration file
  216. parameter in the DOS command line. (ie: LYRICS <config file> /L )
  217.  
  218. Nonstandard IRQs can be used by specifying the IRQ number after the
  219. <config file> parameter in the command line used to run the door as follows:
  220.  
  221.      LYRICS <config file> IRQ
  222.  
  223.  
  224. Batch Files
  225. >>>>>>>>>>>>
  226.  
  227. Here's an example of the batch file needed to run the door:
  228. --------------------
  229. @echo off
  230. cd\doors\lyrics          --> Switch to the door's directory (VERY IMPORTANT)
  231. lyrics lyrics.cfg /f     --> Execute the door with config file and ask the
  232.                              langage to the user
  233. cd\sbbs\node1            --> Go back to BBS directory
  234. exit                     --> Return to BBS
  235. --------------------
  236.  
  237. Most of the BBS programs DO NOT need to have the last line (-> exit <-).
  238.  
  239. Maintenance batch file
  240. ------------------------
  241. @echo off
  242. cd\doors\lyrics          --> Switch to the door's directory (VERY IMPORTANT)
  243. lyrics lyrics.cfg /m     --> Execute the maintenance if it's the first day of
  244.                              the month.
  245. cd\sbbs\node1            --> Go back to BBS directory
  246. exit                     --> Return to BBS
  247. ------------------------
  248.  
  249.  
  250. Sysop Keys
  251. >>>>>>>>>>>
  252.  
  253.      Key(s)              Function
  254.  
  255.      HOME                Toggles between the user status window and a help
  256.                          display that lists the special keys.
  257.  
  258.      F6                  Takes 5 minutes away from the caller.
  259.                          NOTE:  This will NOT be returned to BBS.
  260.  
  261.      F7                  Gives 5 minutes to the caller.
  262.                          NOTE:  This will NOT be returned to the BBS.
  263.  
  264.      F9                  Quit the door and return the caller to the BBS.
  265.  
  266.      F10                 Enter chat mode. Pressing the ESC key exits the
  267.                          chat mode.
  268.  
  269.      Alt+D               Drop to DOS.
  270.  
  271.  
  272. About Lyrics
  273. >>>>>>>>>>>>>
  274.  
  275. Lyrics  is  a  door  program  used  to  keep  a  database of songs lyrics and
  276. Guitar/Bass  tablatures.  It  has  27 categories (one for each letter).  Each
  277. category can hold unlimited songs & tablatures.  You can navigate through the
  278. groups, albums, songs, tablatures and you can see the lyrics/tablatures while
  279. you're  on-line.  You can choose the lyrics & tablatures you wish to download
  280. (a single song, a complete album, a complete group or all tablatures).
  281.  
  282. Here's a brief description of all the menu commands used in Lyrics
  283. ==============================================================================
  284.                               -=> Main menu <=-
  285.  
  286. [1..27] Categories by group's first letter
  287.  
  288. [A]bout Lyrics                -=> Informations about Lyrics
  289. [I]nfos about writing songs   -=> File formats used by Lyrics (see below)
  290. [O]ptions                     -=> Brings you to the Options Menu
  291. [N]ew songs                   -=> Last 400 uploaded songs
  292. [U]pload songs                -=> Select this if you want to upload new songs
  293.                                   to the door's database
  294. [Q]uotes                      -=> Read/Write quotes (100 max.)
  295. [G]et user version of Lyrics  -=> Let the user download the user version of
  296.                                   Lyrics (LYRUSR11.ZIP)
  297. [R]eset selected songs        -=> Delete your selected songs
  298. [D]ownload selected songs     -=> Zmodem download of your selected songs
  299. [V]iew selected songs         -=> View a list of your selected songs
  300. [E]xit program                -=> Return to the BBS
  301.  
  302. Note: - If the sysop want to upload songs locally, just put the file(s) in the
  303.         IMPORT\ directory, enter the door and select the [U]pload command.
  304.       - If the sysop want to download songs locally, select the [D]ownload
  305.         command and name the song file as you wish.
  306. ==============================================================================
  307.                             -=> Options menu <=-
  308.  
  309. [S]earch module               -=> Use it to search into Lyrics database
  310. [C]reate list Lyrics & Tab.   -=> * Make short or long listing of available
  311.                                   Lyrics and/or Tablatures.
  312. [T]op 10                      -=> View the door's statistics
  313. [L]og file                    -=> Sysop: View the log file (w/option delete)
  314. [R]eturn to main menu         -=> Go back to the main menu
  315.  
  316. * Short listing: Groups with albums and number of songs of the album.
  317.   Long listing: Groups with albums and all the songs name of the album.
  318. ==============================================================================
  319.                               -=> Group Menu <=-
  320.  
  321. [1..XX] Group names
  322.  
  323. [E]rase a band                -=> Sysop only: Delete a band
  324. [D]ownload all songs of band  -=> Download all songs of all albums of the band
  325.                                   Note: Does not include the tablatures.
  326. [P]revious page               -=> Used if there's more than 20 bands in the
  327. [N]ext page                   -=> menu.
  328. [R]eturn to main menu         -=> Return to main menu of the door
  329.  
  330. ==============================================================================
  331.                               -=> Album Menu <=-
  332.  
  333. [1..XX] Album names
  334.  
  335. [T]ablatures download         -=> Download all tablatures of the band
  336. [E]rase an album              -=> Sysop only: erase an album
  337. [D]ownload an album           -=> Download all songs of the album
  338. [P]revious page               -=> Used if there's more than 20 albums in the
  339. [N]ext page                   -=> menu.
  340. [R]eturn to group menu        -=> Return to group's menu
  341.  
  342. ==============================================================================
  343.                               -=> Song Menu <=-
  344.  
  345. [1..XX] Song titles
  346.  
  347. [E]rase a song                -=> Sysop only: erase a song
  348. [D]ownload a song             -=> Download a song
  349. [P]revious page               -=> Used if there's more than 20 songs in the
  350. [N]ext page                   -=> menu.
  351. [R]eturn to album menu        -=> Return to album menu
  352.  
  353. ==============================================================================
  354.  
  355.  
  356. File format used by Lyrics
  357. >>>>>>>>>>>>>>>>>>>>>>>>>>>
  358.  
  359. This is for the LYRICS
  360. ===========================
  361. !<Group>
  362. %<Album>
  363. @<Song>
  364. ===========================
  365.  
  366. This is for the TABLATURES
  367. ===========================
  368. !<Group>
  369. @Tab: <Song>
  370. ===========================
  371.  
  372. It's not necessary to rewrite the name of the Group if you use the same,
  373. even if you change the Album or the Song.
  374.  
  375. Same thing for the Album if you write another Song from the same Album.
  376. You can put unlimited Group/Album/Song in the same file.
  377.  
  378. The file name doesn't matter.
  379. You can either send the file zipped or not.
  380. You may upload more than one file at a time.
  381.  
  382. You can upload Internet song files without any modification
  383.   (If so, you'll be prompted for the group and the album name).
  384.  
  385. An Internet file is a file like this:
  386. ======================================
  387. @ALBUM: HEARTWORK
  388.  
  389. @SONG: BURIED DREAMS
  390.  
  391. ...
  392.  
  393. @SONG: CARNAL FORGE
  394.  
  395. ...
  396. ======================================
  397.  
  398. To upload Guitar/Bass tablatures, just ignore the %<Album> line and make the
  399. song's header look like this:
  400.  
  401. -=-=-=-=-
  402. !<Group>
  403. @Tab: <song>
  404. -=-=-=-=-
  405.  
  406. Also, you can upload files with no format at all. You'll prompted to enter the
  407. appropriate informations.
  408.  
  409. Here's an example: MYSONGS.TXT
  410. ==================================
  411. !nine inch nails
  412. %the downward spiral
  413. @closer
  414.  
  415. you let me violate you
  416. you let me desecrate you
  417. ...
  418.  
  419. @march of the pigs
  420.  
  421. step right up march push...
  422.  
  423. !megadeth
  424. @tab: holy wars
  425.  
  426. -----------------------
  427. -----------------------
  428. ---5---3-5---4-----4-5-
  429. ---3-0-2-3-0-2-0-0-2-3-
  430. ...
  431.  
  432.  
  433. ==================================
  434.  
  435.  
  436. Future upgrades
  437. >>>>>>>>>>>>>>>>
  438.  
  439.   - Multi-node support.
  440.   - Maybe less files in DATA\ directory for index/album/songs/data.
  441.   - Printer support within Lyrics (for local use).
  442.   - Rename groups, albums and songs (sysop only!).
  443.   - Remove the UseNet Newsgroup header in songs & tablatures.
  444.   - Moving the groups beginning with "The" in the other first letter.
  445.     (ex: The Beach Boys [database T] -=> Beach Boys [database B])
  446.  
  447.  
  448. History
  449. >>>>>>>>
  450.  
  451. Read the file HISTORY.TXT for more details about versions/upgrades.
  452.  
  453. Lyrics ßΣΓα -=> Released - 03/09/1995.
  454.                 Beta version of Lyrics (English only).
  455.  
  456. Lyrics v1.0 -=> Never released to public (06/26/1995).
  457.  
  458. Lyrics v1.1 -=> Released - 10/13/1995
  459.                 First official version of Lyrics.
  460.  
  461.  
  462. Copyrights
  463. >>>>>>>>>>>
  464.  
  465. Lyrics is copyrighted 1994,95 by Dominic Dupuis
  466. Lyrics is compiled with Turbo Pascal v7.0 (c) 1983,92 by Borland International
  467. Lyrics uses RMDOOR v4.5 (c) 1991-1994 by Mark Goodwin and Randy Hunt
  468. Lyrics uses PKZIP and PKUNZIP (c) 1989-1992 by PKWARE Inc.
  469. Lyrics uses DSZ.EXE (c) 02-02-94 by Omen Technology INC.
  470.  
  471.  
  472. Registration
  473. >>>>>>>>>>>>>
  474.  
  475. The door already have all the options (either registered or not). After a long
  476. month, you must register Lyrics.
  477.  
  478. Just send  me  the  REGBBS.FRM printed to my mailing adress  (top of this doc)
  479. with  the  right  information  and I'll send you back your registration key by
  480. mail. It'll cost you only 5$ to get a registered copy of Lyrics. I didn't made
  481. this  door for the money.  The 5$ will serve to cover the price of the stamps,
  482. the  time  needed  to  process  each demand and the support I give to you when
  483. registered.
  484.