mark-registry(2)

NAME

mark-registry - Modify the operating mode of a registry node

SYNOPSIS

n mark-registry "root" "mode"

DESCRIPTION

mark-registry modifies the mode of a registry node root. If an argument n is supplied then the nth register node down from root (as viewed from list-registry(2) output) is modified instead. The mode is string specifying the modes, each mode is represented by a character. Lower case characters add a mode, upper case characters delete a mode. The modes are defined as:-

? - Query Name


Returns the full name, including path, of the given registry node in the variable $result(5). This does not alter the registry.

! - Hide Value


Hides the value of the given registry node, i.e. the node is displayed but its value will not be displayed in the output of list-registry(2). Once set, this mode cannot be removed.

a - Autosave


Automatically saves the registry when it is deleted or unloaded from the registry. The user is not prompted for a save.

b - Backup


Automatically performs a backup of the registry file whenever a save operation is performed.

c - Create


If the registry file cannot be loaded then the root node is created and the invocation succeeds. If this mode is omitted then the call fails if the file cannot be found.

d - Discard


Marks the registry as discardable. This is typically used for registries that are not saved.

f - File


The registry node is marked as a file root, the value must be set to the registry file name.

g - Get Modes


Returns the list of modes currently set on the given registry node in the variable $result(5). This does not alter the registry.

h - Hierarchy Hidden


The registry node is marked as Hidden, i.e. its children will not be shown in list-registry(2) output. A node is marked has hidden when it is folded up.

i - Invisible


The registry node is not displayed in the list-registry(2) output.

m - Merge


Marks the registry to enable merging, see read-registry(2).

p - Password Encryption


Marks the registry node for encryption using a manually entered password, node must be a file root (see f above). The registry file is encrypted when saved with save-registry(2) using a user entered password. This can be used in conjunction with flag y for increased security. The password must be entered on all read and write operations.

r - Reload


Marks the registry to enable reload, see read-registry(2).

u - Updated


Marks the registry as modified. The modified bit is removed when the registry file is saved. If the modified bit is applied to a registry node the user will be prompted to save the registry when it is deleted (or it will be automatically saved when the Autosave mode is used).

y - Auto-Encryption


Marks the registry node for encryption using an auto-generated encryption key, node must be a file root (see f above). The registry file is encrypted when saved with save-registry(2) using an auto-generated password. This can be used in conjunction with flag p for increased security. Do not rename the physical file as the file name is used as part of the encryption key.

Multiple modes may be applied.

EXAMPLE

A history registry can be hidden with the following invocation:-

mark-registry "/history" "h" 

It could then be made visible again using:-

mark-registry "/history" "H" 

BUGS

At exit only registry nodes attached to the root are saved.

DIAGNOSTICS

mark-registry fails if root does not exist.

SEE ALSO

copy-registry(3), delete-registry(2), find-registry(2), list-registry(2), read-registry(2), save-registry(2), set-registry(2), &reg(4), erf(8).

(c) Copyright JASSPA 2025
Last Modified: 2025/02/10
Generated On: 2025/09/29