helppc.doc

汇编用的MASM LINK DEBUG

	BUILD
			is equivalent to

	INDEXHLP asm c dos hardware interrupt tables misc

	Both of these command lines will index the default databases.  To
	add additional databases just append the filename (extension isn't
	necessary if .TXT is used) to the list.  Here's an example:

	BUILD custom

			is equivalent to

	INDEXHLP asm c dos hardware interrupt tables misc custom

 
	Creating your own Help Files
	============================

	HelpPC in its standard form can handle 1800 indexed topics and 16
	independent help files.  If you find you need a larger capacity,
	please contact me at one of the addresses below.  Each file must
	have its own title which will show up in the main menu.  Each topic
	following the file title (see below) will show up in the subtopic
	menu.  Note that HelpPC will adjust the menu format based on the
	screen height and the number of items in the main menu.

	HelpPC text files are simple ASCII files that contain control codes
	in column one.   Each file must contain a menu title in the first
	line.  The remainder of the file consists of keyed lines and help
	text.  Each line must end with a CR/LF pair (standard DOS format) and
	shouldn't be longer than 79 characters.   Tabs position the text at
	8 character tab positions.  The following is a list of keys and
	special characters (keys are found in column 1, special characters
	appear in columns 1-80):

	 '@'  in column 1 indicates a file title which will appear in
	      the main topic menu.  This must be the very first line
	      in the file and has a maximum length of 40 characters
	      (excluding the '@').
	 ':'  in column 1 indicates a subtopic key.  Multiple keys separated
	      by colons ':' can be entered on the same line.  Single spaces
	      are allowed in a key, multiple spaces are compressed to single.

  HelpPC 2.10     Quick Reference Utility      Copyright (c) 1991, David Jurgens


	 '%'  in column 1 indicates a highlighted title line.
	 '^'  in column 1 indicates a centered highlighted title.
	 ' '  (space) in column 1 indicates normal text.
	 '~'  Tilde is used to mark text as a subtopic link.  Use two
	      tilde characters to represent an actual tilde in the data.
	      A word or phrase enclosed between tilde's will become a
	      subtopic link for the current topic.
	 TAB  in column 1 starts text in column 9
	 any other character in column 1 is truncated

	Use the BUILD command to index/reindex the default help text files.
	To add your own files to the index use the command:

	     BUILD [fname [file2 ...]]

	This information is available in HelpPC with the topic
	"HELPPC FORMAT".



	Limits of the HelpPC program
	============================

	Max items in main topic menu:          16
	Max items in subtopic menu:           512
	Max topics in index:                 1800
	Max size of topic text:             16384 bytes
	Max lines of text per topic:          512 lines
	Max topic key length:                  20 bytes
	Max file title length:                 40 bytes
	No limit on file size



	Special Editor Considerations
	=============================

	With Epsilon, you must setup a TSR popup key.  This is done by
	issuing the "program-keys" command and choosing one of the hotkey
	options [1..4].  Option 4 is the default popup key sequence for
	HelpTSR.  Quit from the menu using 'Q' and then issue the
	"write-state" command to make the configuration permanent.

	The Norton Editor may need configured on a few video systems,
	though there is no rule to determine which.  If you try to popup
	HelpTSR while in the Norton Editor and the context sensitive help
	does not work, then the editor is not using a real cursor (may be
	using reverse video).  To configure the Norton Editor in this
	situation, do the following:

	  F5          Format Menu
	  C           Select cursor type (change to a blinking cursor)
	  F3          File Menu
	  S           Save Modified Editor configuration (it will prompt
	              you for the filename)

  HelpPC 2.10     Quick Reference Utility      Copyright (c) 1991, David Jurgens


	Miscellaneous Notes
	===================

	If the HelpPC program is used in a batch file, the parameters to it
	must not be variable parameters (%0..%9), because DOS strips out
	commas when it parses batch file parameters.  Commas are valid in
	topics and if removed by the command parser will change the command
	line presented to HelpPC.  This usually results in the "Topic not
	found in index" message.

	HelpTSR works in MS Windows DOS sessions.  If HelpTSR is loaded before
	MS Windows, HelpTSR is available in any following DOS windows.  If
	HelpTSR	is loaded from with a DOS window, it is active until the
	window is destroyed.  HelpTSR will not popup over a graphics screen.
	


	43/50 Line users
	================

	Some versions of DOS and ANSI.SYS replacements do not handle 43/50
	line mode correctly.  If the bottom half of the display does not
	scroll correctly in 43/50 line mode, either upgrade to a newer DOS
	or set 43/50 line mode through a program like NANSI.SYS.  This is a
	problem in some DOS versions and not HelpPC.



	Files included with HelpPC
	==========================

	BUILD.BAT     -  A batch file that uses INDEXHLP to rebuild the
			 help index.  This is the simplest way to index
			 the databases.
	HELPPC.COM    -  A display utility that reads the index and databases
	                 and displays the information.  I recommend that you
	                 rename this program to something you find convenient
	                 to use like "H.COM", "HELP.COM" or "INFO.COM".  I
			 prefer "HELP.COM", which conflicts with the DOS HELP
			 command that is supplied with some OEM versions of
			 MS DOS.
	HELPPC.DOC    -  The file you're reading now.
	HELPPC.NDX    -  The data index.  Contains index information on data
			 in each of the .TXT files.  HelpPC finds this file
			 through the environment variable "HLP".
	HELPTSR.COM   -  Context sensitive help TSR.  The program interface
			 is similar to the command line utility HELPPC.COM
			 but has advance features.
	INDEXHLP.COM  -  The help file index utility.  Type INDEXHLP for
			 information on usage.
	README        -  A brief description of how to get started.
	REGISTER.FRM  -  A registration form.  This is also included with the
			 registered versions should one choose to redistribute
			 HelpPC. 

  HelpPC 2.10     Quick Reference Utility      Copyright (c) 1991, David Jurgens


	Data Files:

	ASM.TXT       -  Assembler programming topics.
	C.TXT         -  ANSI, Microsoft and Turbo C functions and C 
			 programming topics.   This may be split into
			 C.TXT, MSC.TXT and TC.TXT in future releases of
			 HelpPC.
	DOS.TXT       -  DOS commands database.
	HARDWARE.TXT  -  Hardware relative programming topics.
	INTERRUP.TXT  -  Documented and undocumented interrupt topics.
	MISC.TXT      -  Miscellaneous topics that have no logical grouping.
	TABLES.TXT    -  Tables, structures and formats of BIOS, DOS and other
	                 programming related tabular information.



	Version News
	============

	2.10 Added subtopic linking, tab support, 486 instructions and timings.
	2.0  Major revision of the user interface including menus.  This is
	     the first shareware release.  Help index utility is included
	     and TSR becomes available with registration.  Some versions
	     went out with David Powell referenced as David Wilson.  This
	     was an error and I apologize to David Powell for this accident.
	1.5  A minor bug in the 43/50 line mode of version 1.4 has been
	     fixed.  Over 900 topics are now included.
	1.2  EMS and Mouse functions were added to the database.  Over 750
	     topics were included.  (limited distribution)
	1.1  Maintenance release of the database.  Several topics were added
	     and existing ones were cleaned up.
	1.0  Original release.



	Registration
	============

	This software is shareware.  If you find this program or accompanying
	data of some value and continue to use either after a 30 day trial
	period registration is required.  Registration costs $25 in the
	United States ($30 otherwise) and provides you with the latest
	version of the program and the databases.  It also places you on the
	update mailing list.   Registration provides the resources to continue
	work on HelpPC.  A registration form is included in the	file
	REGISTER.FRM.  This file is enclosed with the registered version also
	to make it easier to distribute HelpPC to friends and colleagues.
	Here's the pricing schedule for HelpPC.

              Number of copies           Price per copy

                    1                 $25 per diskette
                   2-5                $20 per diskette
                    6+                $15 per diskette
                                      $5 per upgrade (any version)

	Add $5 for addresses outside the U.S.

  HelpPC 2.10     Quick Reference Utility      Copyright (c) 1991, David Jurgens


	Thanks to the following:
	========================

	David Powell of IBM for his BIOS/DOS reference cards which gave me
	the idea that started all of this.  Jeff Miller of CompuServe for
	supporting the project and providing helpful feedback.  Mark Grim,
	Bernd Schemmer and Robert Rosenbach for entering/passing along data
	for HelpPC.  Phil George and Ted Stephens for supporting and testing
	throughout the project cycle.  Dave Drown, Jerry Gibson, Kevin Hughes,
	Charles Lazo III, Jim Milligan, David Powell (of CCS) and Ali Vardag
	for testing and/or providing feedback.  Ray Duncan, Chris Dunford,
	Richard K. Herzog, Jim Kyle, Micheal Mohle, Chip Rabinowitz, Mike
	Rubenstein and Barry Simon for sharing their vast knowledge with the
	rest of us on CompuServe.  Ralf Brown for maintaining "the" interrupt
	lists.  Brett Salter and The Periscope Company for the great support
	and the awesome Periscope debugger which was the main bug buster used
	in writing HelpPC.



	In Closing
	==========

	Use it, try to break it or just tell me what you did or didn't
	like about it or what you'd like to see added.  If you find any
	discrepancies, errors or typos, I would appreciate corrections
	and any suggestions for improvement.  If at all possible,
	please contact me using one of the below addresses and I will
	try to correct the problem immediately.   Additions to the help
	files are welcome and can be submitted to me via any of the
	following addresses.  If the information you provide is used in
	HelpPC,	you will be given credit for the work.

	Please share this program with your friends; but please, if you
	do redistribute this software, distribute it in its original
	.ARC, .ZIP or LHARC form, without modification.  If you think
	it's a worthwhile program, please register.  Your registrations
	will allow continued development on HelpPC.



	I can be reached at any of the following addresses:


	US Snail:       David Jurgens
	                1550 Alton Darby Creek Road
	                Columbus, Ohio  43228

	CompuServe:     70004,30     (read daily)
	                71270,2422   (read weekly)





  HelpPC 2.10     Quick Reference Utility      Copyright (c) 1991, David Jurgens


	Disclaimer
	==========

	The program contained herein, in its original form, is designed
	to work with PC's which are completely IBM DOS and IBM BIOS
	compatible and has been tested on a myriad of PC's and compatibles.
	The information contained within the help databases is correct to
	the best of my knowledge and ability.  Since it was compiled from
	various sources, some in complete disagreement and some continually
	changing specifications, I cannot be responsible for omissions, 
	inaccuracies or plain errors of any type.

	I make no claims to value of the enclosed programs or files,
	or their behavior and assume no liability for damages either
	from the direct use of this product or as a consequence of the
	use/misuse of this product.  Hence this program and all
	information contained within SHOULD BE USED AT ONE'S OWN RISK.

	This disclaimer is included to absolve me from legal issues
	brought about by today's litigious society.