|
|
|
|
|
The fax command allows authorized users to select one of the fax header options for the server: none, default, or custom.
Synopsis
fax header={none | default | custom customtext="header_text"}
Description
You can use the header and customtext parameters to administer the fax header. The following table lists the possible values for each parameter:
Parameter |
Default value |
Possible values |
header |
No default value |
none, default, custom |
customtext |
No default – only applies if header=custom |
Up to 80 character alphanumeric text that can include nms format strings %d, %p, and %P. The text must be inside quotation marks if there is any white space embedded. |
Before the fax header is administered for the first time, no fax header configuration file exists. This file only exists when header is set to default or custom. When header is set to default, an empty nfxheader file is created. When header is set to custom, the customtext value is saved in the nfxheader file.
When the nfxheader file exists, and the authorized user executes the fax command to administer the fax header, the system prompts the user to either confirm or cancel the header file change. If the new header is none, the nfxheader file is removed. Otherwise, the content is modified accordingly.
When the nfxheader file does not exist, and the authorized user executes the fax command, there is no prompt for confirmation. If the new header is none, the nfxheader file is not created. Otherwise, the nfxheader is created accordingly.
Files
The fax header configuration file nfxheader exists when the fax header is set to default or custom. When the fax header is set to default, it is an empty file. When the fax header is set to custom, it may contain an alphanumeric string up to 80 characters long, which is used as the fax header. The NMS supported format strings that can be used in the fax header text are described in the following table:
Format string |
Description |
%d |
Date/time string |
%p |
Page number |
%P |
Total number of pages in this fax |
The nfxheader file is created in the $VS_CONFIG_DIR directory, or /vs/data if $VS_CONFIG_DIR is not defined.
Example
The command
fax header=custom customtext="Page %p of %P. This is a test header %d."
creates the following fax header:
Page 1 of 5. This is a test header THU JUL 25 10:10:48 2002.
See also
