Install S-PLUS Help Files

DESCRIPTION:

A S-PLUS package utility to install S-PLUS help files from .Rd source files.

USAGE:

Splus CMD HELPINSTALL --destdir dirName [files]

REQUIRED ARGUMENTS:

--destdir dirName
the path to the directory where the S-PLUS help files will be installed.

OPTIONAL ARGUMENTS:

files
names of help files to be installed (on UNIX). If file names are omitted, all .Rd files found in the current working directory will be installed. On Windows, these names are ignored.
-h, --help
print usage message.
--clean-first
remove all installed help files before installing new ones.
--clean-after
remove unneeded files after installation. This option is not yet implemented.
--no-clean-after
do not remove unneeded files after installation. This option is not yet implemented.
-v, --verbose
give more detailed progress reports.

SIDE EFFECTS:

On UNIX systems, a .Data directory is created and initialized in the destination directory if one does not exist. If the --clean-first option is given, then all files are deleted from the __Hhelp, __Shelp, and __Jhelp directories that are located in the .Data directory. If file names are included on the command line, then those help files will be installed into the .Data directory of the destination directory. If no file names are given, then all files in the current directory that have the ".Rd" extension will be installed.

On Windows, a ".chm" file is created in the directory one level above the current working directory containing all help files in the current working directory.

NOTE:

Currently there are limitations in HELPINSTALL.

The current working directory must be the package's "man" directory, the directory containing the ".Rd" files, in order for HELPINSTALL to succeed.

On UNIX systems, the destination directory option should be --destdir .. .

On Windows systems, the value of the --destdir option is ignored and the ".chm" file is always put in the directory that is one level above the current directory. Also, any help file names specified on the command line are ignored, all ".Rd" files in the current directory will be installed.

DETAILS:

On UNIX, if a .Data directory already exists in the destination directory, it must be writable.

Currently, the --clean-after and --no-clean-after options are not implemented. For now the utility always does a "clean after" on Windows, but not on UNIX.

The HELPINSTALL utility is invoked from the operating system's command line using the S-PLUS CMD utility. This utility is based on Perl code.

SEE ALSO:

Read Guide to S-PLUS Packages for more information.
S-PLUS functions and (in the pkgutils library).
Other package utilities: , (and DATAINSTALL), , .

EXAMPLES:

# re-install all the help files in the package 
# (current working directory is the package's "man" directory)
Splus CMD HELPINSTALL --clean-first --destdir ..