newdoc

Section: User Commands (1)
Index Return to Main Contents

Name

newdoc - New Document Number Allocation Utility

Syntax

newdoc [ Title [ ShortDescription [ dirfile ] ] ]

Description

newdoc allocates a new document number, based on files present in the current working directory. Documents may be either simple files or directories (containing multiple files making up a single document e.g. a complex Framemaker document). A document is named according to the convention nn.Title, where nn is a 2 digit number, and Title is a short title for a document (containing no white space).

If the arguments are not supplied, they will be prompted for. If arguments are supplied on the command line, and they are to contain white space, remember to enclose them in quotes.

newdoc will create a placeholder file and directory (if dir option used). A summary of the documents present in the directory is maintained in a file 00.ReadMe.

Arguments

Title - This parameter, with the white space removed forms the title part of the filename or directory. Keep this reasonably short.

Short Description - Is used as a short description of the document as part of the 00.ReadMe file. This parameter is limited to one line.

Document Type - This indicates whether the document is a simple single file (the file option), or a directory containing multiple files (the dir option). Only "dir" or "file" are acceptable.

Environment

CLIENT Set this to the name to appear in the client field. If unset, this will default to CiTR.

PATH=$PATH:/home/joppa/horton/bin

or PATH=$PATH:~sdtools/bin

MANPATH=$MANPATH:~horton/man

or MANPATH=$MANPATH:~sdtools/man

Known Bugs

I am sure someone will find some as soon as it is used.

Author

David Horton - CiTR

Copyright

Centre for Information Technology Research, 1992

This document was created by man2html, using the manual pages.
Time: 23:34:46 GMT, September 27, 2019