Added various origin projects
[name-generation.git] / element-lists / names-2.0.1 / doc / names.doc
1 NAMES version 2.01
2 Copyright 1994 by Michael Harvey
3
4 VERSION 2.01:
5
6 Added ELE_DIR environment variable. Names will now (optionally) search
7 the directory listed in ELE_DIR for element files, in addition to the
8 current working directory.
9
10 VERSION 2.0:
11
12 This is a complete rewrite of Names 1.0.
13
14 It works wonderfully on my Linux system; if should port easily to
15 most other UNIXes. The only potential problem is the fie keyb.c,
16 which tweaks the terminal to provide single-key input.
17
18 I haven't tried the new version for DOS; it will probably need some
19 minor changes. In particular, you *won't* need the keyb.c file for
20 DOS; instead, use the getch() function from <conio.h>, for users of
21 Borland and Microsoft compilers. You will also need to either use
22 ANSI.SYS, the -a option, or modify the clear() and move() functions.
23
24 The program is simple. For command-line options, type 'names -h'
25 to get a usage screen. The README-2.0 file has a description of the
26 different options.
27
28 Names will read each of the files specified on the command-line,
29 and combine them internally. It will then display 40 names on the
30 screen, each with a corresponding letter. To save a particular
31 name, press the corresponding letter. It will be added to the
32 output file and the letter will disappear, indicating that name
33 has been saved. To generate another screenful, press the spacebar.
34 You can escape to a shell at any time by pressing '!'. Finally, to
35 quit, just press the Return key.
36
37 The file elements.doc contains useful information on putting together
38 your own element files.
39
40 Comments are always welcome. If you modify Names, port it to another
41 OS, add curses support, or whatever, please send me a copy of the
42 modified sources. Also, if you come up with any really cool element
43 files, I'd appreciate recieving a copy (for my own use!)
44
45 I hope you find it useful. Have fun!
46
47 Mike Harvey
48 mike@cs.pdx.edu
49