# deployhelp

Install, uninstall and manage the local Nelson help system and module help files.

## 📝 Syntax

* deployhelp('install')
* deployhelp('install', verbose)
* deployhelp('add', module\_name, module\_help\_dir)
* deployhelp('remove', module\_name)
* \[status, message] = deployhelp('uninstall')
* status = deployhelp('status')
* \[status, message] = deployhelp('refresh')

## 📥 Input argument

* 'install' - Install the local help system (all modules, all languages). Optional second argument verbose (logical) controls verbosity; default is true.
* module\_name - Name of the module to add or remove from the local help tree.
* module\_help\_dir - Directory containing the module's help archive(s).
* verbose - logical scalar (true/false). When provided to 'install' it controls whether install steps show verbose output.

## 📄 Description

The function manages a local, versioned help directory under userdir()/Nelson//help/.

Actions:

install: creates and installs the local help system (calls docroot('.') and install locally). Use the optional verbose boolean to toggle output.

add: extracts per-language .nhz help archives found in module\_help\_dir/help/ into the versioned help/lang/\<module\_name> directories.

remove: removes the module help directory for each language.

refresh, uninstall, status: respectively refresh the help database, uninstall the local help system, or return whether the local help folder exists. Actions that can fail return \[status, message].

## 🔗 See also

[doc](https://nelson-9.gitbook.io/Nelson/markdown/en/help_tools/doc), [docroot](https://nelson-9.gitbook.io/Nelson/markdown/en/help_tools/docroot).

## 🕔 History

| Version | 📄 Description  |
| ------- | --------------- |
| 1.15.0  | initial version |
