MACROLST.EXE

A Macro Description Listing Utility

Version 5.10, March 20, 1992

MACROLST is a program that creates a WP5.x document containing macro file names and their descriptions. You can then edit and print that file using WordPerfect. (There is an option to create a text file, and to directly print the list; see "Command Line Options" below.) The file is stored in the same drive/directory as the macros. The macro list is sorted alphabetically by file name.

MACROLST normally creates a WP5.x document file, with a DOS text printer defined in the document. When you retrieve the document from List Files (or Retrieve), WP5 will convert it to your default printer.

There are a few simple formatting codes in the MLS document to help make the columns line up. A [Tab Set] code at the beginning of the document will set up the tabs properly. Several [Tab]'s and one [Indent Left] are used to format each line.

When you start the program, just specify the filename pattern of the macro files that you want analyzed. You can do it on the command line:

MACROLST /F=C:\WP51\MACROS\*.WPM

or by entering

/F=C:\WP51\MACROS\*.WPM

when asked by the program. There are several optional parameters you can specify, as described later in this document.

MACROLST seems to need about 90K of free memory to run, so you should be able to run it when you Shell to DOS with WP5's Ctrl/F1 key.

HOW TO RUN THE PROGRAM

In it's simplest form, MACROLST is run at the DOS prompt by typing in

MACROLST

(We assume that you have MACROLST.EXE available in the current directory, or in a directory specified by the DOS PATH command.) Then just follow the instructions on the screen.

COMMAND LINE OPTIONS

There are several command options for MACROLST :

/H or /?	The HELP option shows you a sample command line, the command line options, and the command line you entered. Press any key to continue the program.

/M	Forces Monochrome mode, rather than our favorite cyan on blue colors, if a color card is sensed. This is for users with monochrome monitors connected to their color cards (or if you don't like our colors).

/P	The PRINT option prints the MLS file directly to the printer. It will not create the MLS file on disk, and will print in the default font on your printer. There are no printer control codes, so it will work with any printer. The "/T" (Text) option is not required when you use this option.

/Q	The QUIT option is used to quit after analyzing the group of files specified. Use this option combined with the "/F=<filename>" if you want to set up batch files that don't require user intervention.

/T	The TEXT option creates a text file, rather than a WP5 document. When using WordPerfect 5.0 to edit the text file, use List File's Text In command to retrieve it. The default is to create a WP5 document. The "/T" option is not needed when you use the "/P" (Print) option.

/F=<filename>	The FILENAME pattern option allows you to specify the macro drive/directory specification directly from the DOS command line, rather than inside the program. The <filename> should include the entire drive/path/file name for clarity, such as:

C:\WP51\MACROS\*.WPM

(If you don't specify the drive/path, the default drive/path is used.) This option allows MACROLST to be run as part of a batch file, especially when used with the "/Q" (Quit) option.

You can specify wildcards in the <filename>, such as

/F=C:\WP51\MACROS\MAC*.WPM or

/F=D:\WP51\MACROS\ALT?.*

Note that wildcards ("*" and "?") are allowed with the "/F=" option or as part of the file pattern you specify after the program starts.

/N	The "No Sound" option, for those of you who don't want your neighbors to know you made a mistake.

These options can be specified in any order, can be either upper- or lower-case, and spaces between commands are not required (although desirable for clarity). The options must be entered as shown, otherwise they are ignored.

Here's a sample command line to use in a batch file. It will analyze all WPM macro files in C:\WP51\MACROS, Quitting to DOS when the program is completed.

MACROLST /F=C:\WP51\MACROS\*.WPM /Q

With version 5.10, you can include these options as part of the filename pattern that you enter when the program asks.

THE MACROLST ENVIRONMENT VARIABLE

You can also set a MACROLST environment variable for the command options. This way, you just have to start the program and it will perform the options you specify. For instance, you can duplicate the DOS command line in the previous section by using this SET command:

SET MACROLST=/F=C:\WP51\MACROS\*.WPM /Q

Notice that there are no spaces at the first "=" sign, so you must enter the SET command just like the example (with your options, of course). You can put the SET command in your AUTOEXEC.BAT file, if you wish.

If you see a message "Out of Environment Space", when you use the SET command, add this command to your CONFIG.SYS file:

SHELL=C:\DOS\COMMAND.COM C:\DOS\ /E:256 /p

Substitute the correct directory for COMMAND.COM for your system. This will increase the available space for the SET command to 256 characters.

Although you can specify a filename pattern as part of the MACROLST environment variable, you will have to clear it if you want to analyze macros in another directory. Just use the

SET MACROLST=

command at the DOS prompt to clear the environment variable. But if your macros are always in the same directory, go ahead and use the "/F" option in the SET command.

Use the SET command by itself on the DOS command line to see what your current SETtings are.

HOW MACROLST WORKS

The program was written and compiled using MicroSoft QuickBasic 4.5. It doesn't take a whole lot of memory (about 90K is needed), so you should be able to run it with the Shell/Go to DOS command. We've tried to anticipate most errors, such as incorrect file names, files not found, etc., and give you another chance to enter the correct file names.

MACROLST asks you for the filename pattern of the files you wish to analyze. For instance, you could enter C:\WP51\MACROS\*.WPM to analyze all the WPM macro files in C:\WP51\MACROS. (WP5.x normally gives macros a file extension of WPM, although you can use your own file extension.) MACROLST then uses this filename pattern to create a directory listing of those files.

Each macro file is then inspected, and the macro description is extracted. The description, file name, size, and file date/time is stored into the MACROLST.MLS file that is created in the directory that contains the macro files (in our example, the file would be C:\WP51\MACROS\MACROLST.MLS). The list of macro files are sorted alphabetically by file name.

MACROLST normally creates a WP5 document file, unless you use the TEXT option on the DOS command line. In either case, this is what it looks like:

MACROLST - MACRO FILE LIST/DESCRIPTIONS

Macro files: C:\WP51\MACROS\*.WPM

As of: 02-20-1990, 3:39 PM

MACRO NAME	SIZE	DATE	TIME	DESCRIPTION

ALTB.WPM	85	8-02-88	8:32am	Block a line

ALTC.WPM	84	8-04-88	8:10am	Center a line

ALTD.WPM	92	2-24-89	2:22pm	(not a macro file)

ALTE.WPM	84	1-11-89	12:59pm	(no description)

...etc...

When the program has finished looking at all the files you specified, the MACROLST.DIR file is deleted, and you are returned to the DOS prompt. Notice that some macros don't have a description, and that MACROLST determined that one of the files wasn't a macro file. MACROLST "chirps" (unless you specified the "/N" option) when it finds a non-macro file, or if a file is empty. A short delay of three seconds is used when that happens, unless you've used the "/Q" command line option.

There is a limit of 500 files that MACROLST will analyze. (This is an arbitrary limit, it should be enough for almost everyone. If it's not, we'll change the program so you can have more.)

The MLS file is normally a WP5 document file, use the Retrieve command in WordPerfect to edit it. (If you specified the "/T" command line option, a DOS text file is created. You'll need to use WP5's Text In/Out to retrieve it into a WP5 document.) If you have set up Wordperfect to "Format retrieved documents for default printer" to "Yes", the document will be all ready to print. (Use Setup-Shift F1, Initial Settings to change this.)

When MACROLST has finished analyzing the file(s) you specified, you can enter another filename pattern. (Remember that the MLS file is always MACROLST.MLS, so you wouldn't want to do macros in the same directory without first renaming the MLS file.)

To quit the program, enter QUIT as the file name (or just press Enter). (If the "/Q" (Quit) command line option is used, you are returned directly to DOS.) Use the "/Q" option if you are using MACROLST in a batch file.

RETRIEVING MACROLST'S "MLS" FILE INTO WORDPERFECT 5.x

MACROLST normally creates a WP5.x file, unless you use the "/T" option. To use this file in WordPerfect, start WordPerfect (versions 5.0 or 5.1) and use List Files and Retrieve to edit the MLS document. Or use WordPerfect/Windows to load the file.

Depending on your default printer, the text may not look right at first, because WP5.x needs to reformat your text. A quick way to do that is [PgDn] and [PgUp]. Everything will line up after that.

To print the file, first Retrieve it, then Print it. Make sure that your default printer is selected for the file. The MLS document is formatted for a DOS Text Printer, which most people haven't installed. So when you retrieve the file, WP5 will convert the MLS file to use your current printer definition. Just look at the Selected Printer when you use the Print command to make sure you have selected the correct printer; if not, Select the desired printer.

VERSION CHANGES:

MACROLST has gone through many changes since it's initial release in 1988. For those that have earlier versions, or are just curious, here's the changes made in each version:

1.1 (8/12/88): Minor changes to put the LST file in the directory that is specified, version number shows on screen, a bit more error checking.

1.2 (8/15/88): Added option to not sort the directory list, just in case the SORT command is not available. The command line would then read MACROLST NOSORT . Since the SORT command is an external DOS command, the SORT program must be in the current directory or available in the PATH. This corrects a problem noted by many users on the Source (Thanks to John Liebson, Bob Jacobson, Joan Freidman, and others for pointing out my glaring -- and embarrassing -- gaffe.)

2.0 (9/12/88): Due to popular request, I changed the program so that it would normally create a WP5 document, rather than a text file. But there is an option to create a text file, just add the word TEXT at the DOS command line:

MACROLST TEXT

You can also use the NOSORT option with the TEXT option:

MACROLST TEXT NOSORT

The options can be specified in any order. For more information about these options, please see COMMAND LINE OPTIONS, above.

I also added a HELP option, just in case. If you specify HELP, a help screen will appear, but the program will return you to the DOS prompt.

3.0 (2/21/89): We made some major changes in this version of MACROLST, mostly in the command line options. It also should run a bit faster, since we almost completely re-wrote the program. The new command line options are detailed in a prior section, they make the program a bit more powerful. You might especially like the ability to create a batch file that runs automatically without user intervention.

The MLS file also looks a bit different. We've included the file size along with the file date and time. The filename pattern you specified is shown, so the macro names are shown without the drive/directory name to make them a bit easier to see. You can specify any filename pattern you wish, earlier versions assumed that all macro files have a file extension of WPM (all others were ignored). We removed the requirement for the DOS SORT program, since we now sort the filenames internally. And the resultant list file has a file extension of MLS (for Macro LiSt).

Earlier versions of MACROLST had a tendency to leave extra DIR files laying around. We think we took care of that minor annoyance.

3.01 (4/5/89) Just some minor improvements this time. We also expanded the documentation file.

3.03 (1/1/90) Minor documentation changes, and we verified that it works with WordPerfect 5.0 and 5.1 macros.

4.x We skipped this version, so that it would match WordPerfect's version number.

5.0 We skipped this version also, so we could catch up with WordPerfect.

5.10 (3/20/91) After a long wait, I finally got around to fixing the problem with MACROLST not working with DOS 5.0. (It's a little embarrassing that it's taken this long to get MACROLST to work with DOS 5.0. I've known about it for a long time, but never could find the time to get it fixed. And I wanted to do a new version of MACRODOC that would combine it's functions with MACROLST, but that was harder than I thought...I'm still not done with that!)

Here's what's new:

- There's a bit more error checking in the program, so at least you will know why it dies.

- added "/N" option (for no sound)

- added "/?" as another way to get the help screen.

- made some minor screen enhancements, such as a counter to let you know how many files will be analyzed.

- This version also works with WordPerfect 5.1 macro files (as it has since version 3.x), but not WP/Win macros. (If I can ever fix my bad hard disk, I might be able to get those working also.)

- You can run MACROLST in Windows 3.0 or 3.1 in a DOS Window

- MACROLST will analyze up to 500 macros (that's why you need this program!)

- you can include options as part of the filename pattern after the program has started. (Previously, you could only do it on the DOS command line.)

- you can include options as a SET parameter in your environment (see the Setting the MACROLST Environment Variable section above).

- some minor documentation changes

A SHORT PLUG FOR OUR OTHER PROGRAM

MACRODOC -- OUR MACRO DOCUMENTER

MACRODOC is a program that documents your macros. It translates macros into a text or WP5.x file, so you can really see how those macros are written.

MACRODOC is copyrighted shareware, with a $25 registration fee.

A SPECIAL DEAL

If you want to get registered copies of the latest versions of MACRODOC and MACROLST, send along a $25 registration fee (or send $20 with a formatted disk in a return postage paid mailer) and the registration page of this document. We'll send back the latest versions, and our thanks. Be patient, though. Sometimes we are working on a new version, and delay shipping disks until that version is completed.

You can also find the latest versions of all four programs on CompuServe's WPSGA Forum (GO WPSGA) in DL4 (unless they moved <it). Look for MACROL.ZIP and MACROD.ZIP.

WE PRACTICE "SAFE COMPUTING"

We scan all disks with two virus checkers before we send the program back to you. We'll call you (in the U.S. and Canada) if we find a virus on the disk that you sent.

HOW TO FIND ME

We're interested in your suggestions on how to improve the program, and if you have problems. The fastest way to contact me is electronically. You can leave an EMAIL message on CompuServe (71331,514). We also have a fax number (available when the kids aren't using Prodigy!) at (916) 663-1793. We have an Intel Satisfaxion fax board; if you have one too, you can send us a file as well as a fax. Include your fax number, and we'll "fax you back". We'll try to respond quickly; we're on Compuserve almost daily. You can also use the comment form at the end of this document if you wish.

We'll be posting information about new versions of this and other programs on CIS when they are ready.

You can contact us by mail at:

PLACER COMPUTER SYSTEMS

9197 Los Puentes Road

Newcastle, CA 95658-9706

Rick Hellewell (CIS: 71331,514)

FAX (evenings only): (916) 663-1793

------------------------------------

Product Registration Payment Form

------------------------------------

To order your registered copies of MACRODOC and MACROLST, please fill out the form below. Use your mailing address only, please. Shipments are normally made via U.S. Mail. Circle your disk size preference (5 1/4", 3 1/2").

Date: _____________

Name: _____________________________ Title: ___________________

Company: ________________________________________________________

Address: ________________________________________________________

_________________________________________________________________

City: ___________________________________________________________

State/Country: ________________________ Zip: ____________________

Phone Work: (_____) _____ - ______ Home: (_____) _____ - ______

Method of payment: Please complete the worksheet below and choose one of the payment options indicated. California State residents must add sales tax. ALL CHECKS AND MONEY ORDERS MUST BE DRAWN ON U.S. ACCOUNTS ONLY.

|================================================================|

|	|	| Cost	| Total	|

| Qty	|	Description	| per unit	| Cost	|

|================================================================|

|	|	MACRODOC/MACROLST package|	$25.00	|	|

|	|	(I'll use my disks and |	|	|

|	|	return postage) |	|	|

|================================================================|

|	|	MACRODOC/MACROLST package|	$20.00	|	|

|	|	(you sent a disk with |	|	|

|	|	return postage) |	|	|

|================================================================|

|	California residents add sales tax |	|

|--------------------------------------------|---------|

| Shipping Cost if Overseas, add $10.00	|	|

|======================================================|

|	TOTAL	|	|

|======================================================|

Payment type	[ ] Check enclosed	[ ] Money Order

(Funds drawn on U.S. Banks only)

Signature: ______________________________________________________

*****************************************************************

Send all items to: PLACER COMPUTER SYSTEMS, 9197 Los Puentes Road

Newcastle, CA 95658-9706

*****************************************************************

Thanks for your registration!

---------------------

PROGRAM COMMENT FORM

---------------------

Your comments about this software and documentation are welcome. Please take the time to fill out this form. You can mail or fax this form with your comments.

Name: _____________________________ Title: __________________

Company: _______________________________________________________

Address: _______________________________________________________

________________________________________________________________

City: __________________________________________________________

State/Country: ________________________ Zip: ___________________

Phone Work: (_____) _____ - ______ Home: (_____) _____ - ______

MACRODOC Version Number: _____________	Date: __________________

MACROLST Version Number: _____________	Date: __________________

________________________________________________________________

________________________________________________________________

________________________________________________________________

________________________________________________________________

________________________________________________________________

________________________________________________________________

________________________________________________________________

*****************************************************************

Send all items to:	PLACER COMPUTER SYSTEMS

9197 Los Puentes Road

Newcastle, CA 95658-9706

Fax: 916-663-1793

*****************************************************************

LICENSE AGREEMENT

Here's some legal stuff:

The MACRODOC(R) Products are NOT "Public Domain" and they are NOT "Freeware". MACRODOC are copyrighted software products developed and owned by Placer Computer Systems located in Newcastle, California, U.S.A. Placer Computer Systems grants you without charge the right to reproduce, distribute and use copies of this version of our MACRODOC shareware software products, subject to the limitations specified below, and on the express condition that you do not receive any payment, commercial benefit, or other consideration for such reproduction or distribution, or change this license agreement or the following copyright notice which appears in the software, documentation, user interface, menus and magnetic media: (C) Copyright 1988-1990 by Placer Computer Systems. All rights reserved worldwide.

Limitations: You may make and keep one (1) back-up copy of the software for your personal use, provided that (i) you copy all the copyright, trademark, and other information indicated on the initial screen display (or on the diskette label, for the registered version disk) onto your backup diskette label, and (ii) you have registered. Also you may distribute copies of the program, including documentation, to other persons, but solely for their evaluation (i.e., to decide whether to continue using the product and therefore register) and solely for evaluation by such other persons during that thirty (30) day period. MACRODOC must NOT be sold or otherwise provided as part of a larger system, or as a part of a more inclusive product or service, without express written consent and licensing from Placer Computer Systems. You can install an additional copy on your other (home or work) computer.

The rights to receive any such financial or other benefit, and to modify the product or employ its components in any kind of derivative work, are reserved exclusively by Placer Computer Systems. Support from users enables us to develop additional features and future versions of the MACRODOC products.

Registered users benefit from enhanced technical support, notice of new products, and bulletin board access. Contact us at:

PLACER COMPUTER SYSTEMS

9197 Los Puentes Road

Newcastle, CA 95658-9706

(916) 663-1666

CompuServe: 71331,514

FAX (evenings only): (916) 663-1793

Also, please feel free to contribute your ideas regarding desired additional product features and functionality.

THIS PRODUCT IS LICENSED "AS IS" WITHOUT ANY WARRANTY OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE, PERFORMANCE, OR OTHERWISE; ALL WARRANTIES ARE EXPRESSLY DISCLAIMED. BY USING THE MACRODOC PRODUCTS, YOU AGREE THAT NEITHER PLACER COMPUTER SYSTEMS NOR ANY OFFICERS, DIRECTORS, EMPLOYEES, SHAREHOLDERS, AFFILIATES, OWNERS, OR OTHER RELATED PARTIES WILL BE LIABLE TO YOU OR ANY THIRD PARTY FOR ANY USE OF (OR INABILITY TO USE) OR PERFORMANCE OF THIS PRODUCT, OR FOR ANY DAMAGES WHATSOEVER WHETHER BASED ON CONTRACT, TORT OR OTHERWISE. EVEN IF WE ARE NOTIFIED OF SUCH POSSIBILITY IN ADVANCE. (SOME STATES DO NOT ALLOW THE EXCLUSION OR LIMITATION OF INCIDENTAL OR CONSEQUENTIAL DAMAGES, SO THE FOREGOING LIMITATION MAY NOT APPLY TO YOU.)

You may not reverse-engineer, disassemble, modify, decompile or create derivative works of the product. You acknowledge that the products includes certain trade secrets and confidential information, all of which are the copyrighted intellectual property of Placer Computer Systems. MACRODOC are registered trademarks of Placer Computer Systems. All rights are reserved worldwide. IBM, PS/2 and Personal System/2 are registered trademarks of IBM Corporation.

RESTRICTED RIGHTS LEGEND

Use, duplication or disclosure by the Government is subject to restrictions as set forth in sub paragraph (c) (1) (ii) of the Rights in Technical Data and Computer Software clause of DFARS 252.227-7013. Placer Computer Systems, 9197 Los Puentes Road, Newcastle, CA 95658-9706. (916) 663-1666.