HELIOS Base UB+ User manual


19 Preferences

Note: Usually, almost all preferences for program functions and behavior of the HELIOS products can be set via HELIOS Admin. That means that it is not required to modify preferences manually. Nevertheless, in the following the single preferences and their function are described.

The server preferences are stored in a binary file. In the following, the preferences are listed by name, type, and default value. The default value is used by the HELIOS services unless another value is specified. Not all of the following preferences are set by default, meaning they are not listed in the "prefdump" output, so HELIOS Services will use the given default values. When a different value is set by means of "prefvalue", this will take precedence. To revert back to the default value delete the preference entry.

Exporting, setting/deleting and restoring preferences on the HELIOS host is done via the programs "prefdump", "prefvalue", and "prefrestore". For a detailed description of these programs see 8 "HELIOS utility programs".

Important: Make sure that preference keys DO NOT start or end with a slash ("/") character, and note that they are case-sensitive! Also, if any preference key or preference value includes spaces, that key or value must be enclosed in quotes.

19.1 Volume preference keys

The following keys require the volume to be mounted anew to take effect:

Key: Volumes/<UNIX directory>/<preference>
Preference
Type Default (""=empty string)
AFPName
str ""

Sets the Mac AFP volume name. The setting reflects that of the AFP Name field in the HELIOS Admin Volume configuration window.

SMBName
str ""

Sets the PCShare SMB volume name. The setting reflects that of the SMB Name field in the HELIOS Admin Volume configuration window.

Password
str ""

Specifies the volume password (currently only supported on Mac). The setting reflects that of the Password field in the HELIOS Admin Volume configuration window. The password is specified as MD5 hash code. It can be batch generated using "authutil" (see 10.2 "authutil").

Removable
bool FALSE

Only set this flag to TRUE for removable media attached to the host which are normally changed while the host is running (e.g. MO drives). Do not apply this setting for local volumes. The setting reflects that of the Exchangeable checkbox in the HELIOS Admin Volume configuration window.

Readonly
bool FALSE

This flag must be set to TRUE when the underlying physical media is write protected (e.g. CD-ROM). Then, there is
- for all users - only read access to the specific volume. The setting reflects that of the Read Only checkbox in the HELIOS Admin Volume configuration window.

AFPPublish
bool FALSE

With this flag set to TRUE, the particular volume is published for Mac clients. The setting reflects that of the Macintosh visible checkbox in the HELIOS Admin Volume configuration window.

Guest
bool TRUE

With this flag set to TRUE, guest access is allowed on the particular volume. The setting reflects that of the Guest Access checkbox in the HELIOS Admin Volume configuration window.

UTF8
bool TRUE

This flag makes the host use the Unicode character set encoding on the specific volume. This provides a correct cross-platform file name display (particularly if the names contain special characters, such as "umlauts" between Mac clients, PC clients, and UNIX servers). The setting reflects that of the Unicode/UTF8 checkbox in the HELIOS Admin Volume configuration window.

HideDotFiles
bool FALSE

This flag makes the HELIOS Admin server pass files which start with a dot (".") in their file name as "hidden" to the connected client. The setting reflects that of the Hide "dot files" checkbox in the HELIOS Admin Volume configuration window.

Close
bool FALSE

This flag specifies how the file server reacts to a file close command from a PCShare client. close disables the file descriptor caching, so files are closed immediately as soon as the file close command is received. The setting reflects that of the Close Option checkbox in the HELIOS Admin Volume configuration window.

Groups
strlist ""

Specifies a list of groups which are granted access to this particular volume. The setting reflects the entries in the Group field in the HELIOS Admin Volume configuration window.

IPAccess
str ""

Specifies the file name of the IP access list that makes the particular volume visible for clients which have one of the IP addresses on the IP access list.

AFPCharset
str MacRoman

If the UTF8 flag is set the charset flag is used to translate and encode file names to the "MacRoman" or "SJIS" character set. The setting reflects that of the AFP Charset pull-down menu in the HELIOS Admin Volume configuration window.

SMBCharset
str PC850

If the UTF8 flag is set the charset flag is used to translate and encode file names to the "PC850" or "SJIS" character set. The setting reflects that of the SMB Charset pull-down menu in the HELIOS Admin Volume configuration window.

SMBPublish
bool FALSE

With this flag set to TRUE, the particular volume is published for Windows clients. The setting reflects that of the Windows visible checkbox in the HELIOS Admin Volume configuration window.

closedirs
bool FALSE

This flag specifies how the file server reacts to a directory close command from the PCShare client. closedirs disables the directory descriptor caching, so directories are closed immediately as soon as the directory close command is received.

mandatory
bool TRUE

This flag specifies whether or not the server allows record locking between multiple PCShare clients.

compatdeny
bool TRUE

This preference specifies how the server reacts if a PCShare client opens a file for reading or writing without indicating how (and whether) the file can be simultaneously opened by other programs. Normally, if a file is opened for reading, other users can only open the file for reading ("deny other write"). Furthermore, if a file is opened for reading and writing, other users cannot open the file at all ("deny other all").

useunixperm
bool FALSE

By default, the AFP server uses the HELIOS smart permissions for files and directories on the server. This means that files saved to the server will inherit the permissions of the parent folder. If this preference is set to TRUE, HELIOS smart permissions are turned off and standard UNIX permissions are used when saving files and folders. The setting reflects that of the AFP UNIX Permissions checkbox in the HELIOS Admin Volumes configuration window.

UseSQL
bool TRUE

By default the new desktop database format is used for HELIOS volumes. The new format can be disabled when setting this preference to FALSE.

19.2 Global preference keys

Key: Global/Programs/<preference>
SMTPHost
str mailhost

Specifies an SMTP host to which the mail client can hand over the message. The setting reflects that of the SMTP Host field in the SMTP tab of the HELIOS Admin Server Settings configuration window. SMTPHost may also contain apart from the actual address of the SMTP server the name and password for authentication:

name:password@Serveraddress

See also mail in 19.3.2 "Output driver settings".

SMTPSender
str root

Specifies a default mail sender address. The setting reflects that of the SMTP Sender field in the SMTP tab of the HELIOS Admin Server Settings configuration window.

See also mail in 19.3.2 "Output driver settings".

SMTPDomain
str ""

Specifies the mail domain for print job email notification. Emails are sent to <username>@<SMTPDomain>. If this preference is not specified, the email is sent to <username>. The setting reflects that of the SMTP Domain field in the SMTP tab of the HELIOS Admin Server Settings configuration window.

See also mail in 19.3.2 "Output driver settings".

LabelNames
strlist "Gray", "Green", "Purple", "Blue", "Yellow", "Red", "Orange"

Specifies the names for file and folder color labels. Corresponds to the Label Name values assigned in the HELIOS Admin Color Labels configuration window. Values are specified in a comma-separated stringlist, e.g.: "Gray,Green,Purple,Blue,Yellow,Red,Orange"

The default values are the color names used in Mac OS X.

LabelColors
strlist "9E9E9E", "9BE233", "ED5FB1", "369EDE", "F3E734", "FF3F4B", "FFB634"

Specifies the six-hexadecimal digit color codes that correspond to the LabelNames preference (above), and to the Color values assigned in the HELIOS Admin Color Labels configuration window. Values are specified in a comma-separated stringlist, e.g.:

"9E9E9E,9BE233,ED5FB1,369EDE,F3E734,FF3F4B,FFB634". The default values are the color values used in Mac OS X.

19.3 Printer preference keys

Key: Printers/<printer queue>/<preference>

All preferences in this section may also be set globally:

Key: Global/Printers/<preference>

19.3.1 Spooler/Input settings

afpsessionsonly
bool FALSE

This preference is used for enhanced user authentication on PAP and TCP queues. If set to TRUE, only users that have an open AFP volume (and are therefore authenticated to the AFP server) can print to this queue. But this authentication only works if the queue and the AFP connection use the same address space. Newer Mac OS versions ( 9) use AppleTalk via TCP/IP, so these connections can only be used by TCP queues. Holding down the option key while you log on to the AFP server under Mac OS 9, you connect to AFP via AppleTalk. This can be used to authenticate for PAP queues.

CheckFonts
bool TRUE

If set to TRUE, this preference will induce the OPI server to stop the print job and issue an error message if the current print job contains any fonts that are not available. The setting reflects that of the Check Fonts checkbox in the HELIOS Admin printer configuration OPI tab.

Groups
strlist ""

Specifies a list of groups, separated by a comma. If a TCP/IP or PAP printer queue is set to afpsessionsonly (TRUE) only users which are authenticated by the AFP server and are specified by this preference, can use this printer.

If the queue is an SMB printer queue it will only be visible to members of the specified groups.

fontdir
str "var/spool/psfonts"

Specifies the path of the host directory which contains the server font list "FontDirectory". The fonts are contained in subdirectories of the file, arranged alphabetically.

dictdir
str "var/spool/dicts"

Specifies the path containing PostScript dictionaries and printer "prep" files, such as "AppleDict..." and "HeliosDict...". You can specify an alternative path here if one of your printers is not fully compatible to the Apple LaserWriter and needs other dictionaries and/or "prep" files. Normally, all PostScript printers share the same files.

holdq
str "None"

Specifies a Hold Queue out of the already installed printer queues. It corresponds to the Hold Queue pull-down menu in the HELIOS Admin Printer configuration window.

hidefonts
bool FALSE

Causes the print server to "pretend" to have no font installed, which would induce the client application to include all needed fonts in the print job. The setting reflects that of the Hide Server Fonts checkbox in the HELIOS Admin Printer configuration General tab.

errorq
str "None"

Specifies an error queue out of the already installed printer queues. It corresponds to Error Queue in the HELIOS Admin Printer configuration window.

SMBExportName
str ""

Specifies the PCShare export name of the particular printer. It corresponds to the SMB Name field in the HELIOS Admin Printer configuration window.

SMBExportSpec
str ""

Specifies the path of the UNIX command which is used to issue print jobs.

WinDriver
str ""

Specifies the Windows printer driver name. This preference corresponds to the Driver Name field in the HELIOS Admin Printer configuration window.

tcpport
int see text

Specifies the address of a specific TCP port for this printer in order to allow easy access for remote printing through a Firewall. If this preference is missing the printer can only be reached via master TCP port. There is no default value for this preference.

tcpname
str ""

Specifies the name under which the TCP printer is registered via mDNS ("Bonjour"), and under which this printer can be reached via the master TCP port. It corresponds to the TCP Name field in the HELIOS Admin Printer configuration window.

papname
str ""

This preference sets the AppleTalk name of the PAP server. This is the name with which it is known to the network. Several names in a row, separated by a comma, are optional. It corresponds to the PAP Name field in the HELIOS Admin Printer configuration window.

authenticate
bool FALSE

This switch determines whether printing to a LaserWriter queue is password-protected or not. In case the flag is set to TRUE, user name and password have to be entered before printing. This setting affects all LaserWriter printer queues on the same server. The setting reflects that of the Require Authentication checkbox in the HELIOS Admin Printer configuration window.

PAPPublish
bool TRUE

Specifies whether the particular printer is published for PAP clients, i.e. for Mac clients. The setting reflects that of the Macintosh - PAP checkbox in the HELIOS Admin Printer configuration window.

SMBPublish
bool TRUE

Specifies whether the particular printer is published for SMB clients, i.e. for Windows clients. The setting reflects that of the Windows - SMB checkbox in the HELIOS Admin Printer configuration window.

TCPPublish
bool TRUE

Specifies whether the particular printer is published for TCP clients. The setting reflects that of the TCP Printer checkbox in the HELIOS Admin Printer configuration window.

type
str "LaserWriter"

This preference is the AppleTalk type of the printer with which it is known to the network. This preference should normally be set to "LaserWriter", "ImageWriter" etc., since only then it will be recognized by the standard Apple Chooser extensions on the workstations. If the workstations are provided with a later version of the LaserWriter program, which also allows other printer types, a different type can be specified here if necessary.

zone
str ""

Specifies the name of the AppleTalk zone(s) to which the printer should be allocated. Thus, it determines the zone in which the Print server can be seen in the Apple Chooser. The chosen zone must be one of the local zones that the server is connected to. We strongly recommend to test this using the UNIX program "zones -l".

lpr
str ""

Specifies the path (including the file name) of an alternative "lpr" program to the one normally used by "papsrv". This preference can be used to specify another "lpr" program which is different from the one normally selected by "papsrv". You should use this preference if you have developed your own custom "lpr" program. You can also use this option to specify a shell script.

filter
str ""

Specifies the path (including file name) of a custom filter program which is called in a pipe with the "standard input" connected to the print job and the "standard output" connected to "lpr". The job will already be resolved if the resolve preference is set to TRUE.

filter may be used in conjunction with the standard EtherShare interface programs.

filtercmd
str ""

Specifies the path (including file name) of a custom filter program which is called as follows:

path -Pprintername spoolfile

The "filtercmd" program can then process the file (which is not resolved) as required. The output file should appear under the same name ("spoolfile") given in the argument - "papsrv" will wait until the custom filter program has finished before processing the job further. Compared to the filter preference, filtercmd can be used for example to add a header (e.g. a PostScript init) or a trailer to the file without having to process the whole file. Use filter instead if you need to parse the entire file, e.g. for font names or job information.

filtercmd may be used in conjunction with the standard EtherShare interface programs.

resolve
bool TRUE

The resolve switch causes "papsrv" to "resolve" all print jobs for the specified printer queue before they are sent to "lpr", i.e. "papsrv" incorporates all required font, dictionary groups and OPI image information into the jobs in advance, and resolves "%%Include..." references. This is needed whenever you want to use printers that cannot be driven directly by the printer interface programs supplied with EtherShare. But be aware that if you use the resolve switch you will need substantially more spooling space on the local server.

Usually, print job resolving is done on-the-fly, by the specified interface program, such as "papif", and jobs queued in the printer's spool directory are not yet resolved. This design approach saves spooling storage, particularly if you are using ImageServer.

The resolve switch causes the "papsrv" to call the pseudointerface program "HELIOSDIR/bin/psresolve", which compares the fonts needed by the document with the printer's resident font list ("FONTS" file in the printer's spool directory), and with the list of available server fonts in
"HELIOSDIR/var/spool/psfonts/FontDirectory". Thus, this is more intelligent than choosing Postscript Job from the application's print dialog - the latter always includes all document fonts, regardless if needed or not.

You should use the resolve switch to prepare print job files for printing offline or with a printer or typesetter whose hardware interface is not supported by HELIOS, but you must not use resolve in conjunction with the standard printer interface programs, because all references will be included twice and the job will fail.

The resolve switch must be specified in each "papsrv" entry for which job resolving is desired.

Be aware that if the job then gets printed on a different host and/or printer, it will not contain all required fonts if it has been resolved with an inappropriate "FONTS" file.

foreground
bool TRUE

The "papsrv" induces Apple's LaserWriter printer driver to spool the jobs directly to the selected EtherShare queue by default.

pstitlescript
str ""

Value is the name of a scripting table, e.g. SJIS. This implies auto detection of PC or MAC originated PostScript jobs.

19.3.2 Output driver settings

IfType
str ""

Specifies the printer connection type for a particular printer, e.g. AppleTalk, TCP, Create PDF, Windows Printer, etc. The setting reflects that of the Connection field in the HELIOS Admin Printer configuration window.

mail
bool TRUE

Determines whether printer errors are reported back to the originator of the print job via email. Even if you specify FALSE, printer errors are still recorded in the printer log file, and many types of errors are also written to the system messages file, allowing you to view them later with the HELIOS Admin or an editor program.

Note: The global preferences SMTPHost, SMTPSender, and SMTPDomain (see above) must be set up correctly for email notification to work.
watchtime
int 10

Specifies the time interval in seconds with which the printer interface program interrogates the printer's status channel. As a diagnostic aid, you can use the UNIX "lpq" program to check the status of each spooled printer. "lpq" returns the status messages that you normally see in the dialog box of the LaserWriter driver for locally connected AppleTalk printers.

This preference has been provided because the PostScript processors of some printers time out in certain unusual situations if you check the printer's status channel for extended periods of time.

chargebanner
bool TRUE

This switch causes the printer's page count to include the number of banner pages in the total amount of pages.

bannerlast
bool FALSE

This preference determines that the banner page is output after the print job has been terminated on the printer.

bannerfirst
bool TRUE

Causes the printer to output a banner page before the print job (compare bannerlast above).

magic
bool FALSE

PostScript printers normally cannot accept print jobs consisting of "flat" ASCII data. They require the print job to be in PostScript format. ASCII print data can be manually converted to PostScript with the "pstext" utility. In addition to this, the interface programs of the Print server are also able to automatically detect whether a particular job is in PostScript or ASCII format, by scanning the start of the job for the "signature" string "%!PS-Adobe". If this string is missing, the job is assumed to be non-PostScript, and is converted to PostScript automatically before printing.

ctrld
bool FALSE

This flag determines whether the "Ctrl-D" character should be used to indicate "end-of-print-job". This is necessary if the printer is connected to TCP/IP through a terminal server and a serial interface.The setting reflects that of the CTRL-D for job end checkbox in the HELIOS Admin Printer configuration window.

clientmessages
bool TRUE

This flag determines whether printer status messages are reported to the AFP-client (or PCShare client, respectively). These messages pop up as display messages and report e.g. paper jams, misfed paper, and other printer-related errors.

spoolspool
bool FALSE

This flag determines whether a spooled print job is "marked" with the information that it has already been spooled. If is set to TRUE, a spooled print job is not recognized as already spooled, thus setting this preference to TRUE is only meaningful for the first spooler in line of a chained HELIOS printer queue.

ignoreresolveopts
bool FALSE

This preference makes, when set to TRUE, a second spooler ignore all remarks on resolved references from a prior spooling process. If you merely want a spooler to ignore single references, e.g. references regarding included fonts etc., you may set one or more of the following flags:

ignoreprocset-resolveopt
bool FALSE

With the ignoreprocsetresolveopt flag set, the next (second) spooler ignores information about included procsets only.

ignorefontresolveopt
bool FALSE

With the ignorefontresolveopt flag set, the next (second) spooler ignores information about included fonts only.

ignoreinclude-resolveopt
bool FALSE

With the ignoreincluderesolveopt flag set, the next (second) spooler ignores information about included EPSF files only.

ignoreopiresolveopt
bool FALSE

With the ignoreopiresolveopt flag set, the next (second) spooler ignores information about resolved OPI-references only.

rsslimit
int 0

The preference rsslimit (resident set size limit) is determined by the maximum number of kB a printer interface program can utilize as memory. If this preference is not set, the memory administration is up to your system settings.

nice
int 0

The priority of a printer interface program - compared to other executable programs on the Print server - can be altered. The UNIX preference nice lets you increase/reduce the priority, and therefore the speed of a program. The higher the priority of a program, the less "nice" its behavior towards other applications. Possible values are:

value for nice > 0 slower / "nicer" towards other
applications

value for nice < 0 faster / less "nice" towards other
applications

extendedinfo
bool TRUE

The printer log files ("printer.acct.x") contain information about printing time/date, document name, user, fonts, and more. With this flag set to TRUE, the range of information for each print job is increased by e.g. an OPI image replacement list and the total number of bytes printed.

facility
str ""

facility is a string that ought to be set by the system administrator only, since its use requires advanced knowledge on UNIX programming. For further reference see the UNIX manual pages "syslogd(1)".

19.3.3 "tcpif" preference keys

host
str ""

(HELIOS Admin option Host Name)

Specifies the Internet number of the printer in the TCP/IP network (or of the printer's terminal server, if any).

service
str ""

(HELIOS Admin option Port)

This preference specifies the service port number (also called the service code), which specifies the process within host which is responsible for the printer. The port number is between 1 and 65535.

rprinter
str ""

Specifies the name of the remote printer on the remote host, as stated in the "HELIOSDIR/var/conf/printcap" file.

tcpresolve
bool TRUE

(HELIOS Admin option PostScript Printer)

When a print job is processed, and the flag is set to FALSE, the print job remains "untouched" and is passed on without any changes.

statusport
bool TRUE

Specifies whether a separate communications channel for status messages with the address <port+1> is provided.

19.3.4 "diskif" preference keys

diskresolve
bool TRUE

(HELIOS Admin option PostScript Printer)

Specifies if any resolving is done within a PostScript job. When a print job is processed to a "Print To Disk" queue, and the switch is set to FALSE, the print job remains "untouched" and is passed on without any changes.

pssuffix
bool TRUE

This flag determines whether the suffix ".ps" is appended to the processed print job file. In case the switch is set to FALSE the file name extension ".ps" is omitted.

prefix
str ""

(HELIOS Admin option Name Prefix)

Specifies whether files which come from a specific printer queue are "marked" with a prefix before their original file name. This may be quite reasonable when several
"Print To Disk" queues print to the same destination.

dir
str ""

(HELIOS Admin option UNIX Directory)

Specifies the (absolute) UNIX path of the directory, where the processed print job is stored. The file name results from the print job title with the typically appended suffix ".ps".

If dir points to UNIX FIFO (named "pipe") rather than pointing to a directory, the processed print data are written to that "pipe" directly.

If dir starts with a pipe character ("|") the whole string following "|" is recognized as a UNIX command line, and the processed print data are piped into the executed program.

notifyprog
str ""

(HELIOS Admin option Notify Program)

This preference will only be recognized if also dir is specified. This preference is called as soon as "diskif" has successfully resolved the print job.

E.g.: notifyprog=/usr/local/bin/disknotify

"diskif" exports the following environment variables during the program call:

HELIOSDIR=
<environment variable for the HELIOS install path>
HELIOS_JOBFOR=
<user name (if available) of print job creator>
HELIOS_JOBUSER=
<user name (if available) as known to "lpd">
HELIOS_JOBHOST=
<name (if available) of server which hosts the printer queue>
HELIOS_JOBTITLE=
<print job title (if available)>
HELIOS_PRINTERNAME=
<logical (UNIX) name of the printer queue>
HELIOS_JOBPAGES=
<expected number of pages. This value may differ slightly from the actual number>
HELIOS_JOBSIZE=
<expected print job size (in bytes). The stated value is often smaller than the actual size>
HELIOS_DFFILE=
<name of created PostScript file.>
compression
str ""

(HELIOS Admin option Compression)

Determines the compression type. You can choose from different types of compressing: Compress and ZIP. None means that there is no file compression applied at all.

diskuserdir
bool FALSE

(HELIOS Admin option Create Folder for Each User)

Specifies if the PostScript files are stored in a folder
per user.

19.3.5 "holdif" preference keys

jobholdtime
int 0 (i.e. )

(HELIOS Admin option Hold Time)

Determines the time a processed print job remains in a
hold/error queue. If jobholdtime is set to 0, the print job perpetually remains in the hold/error queue. This preference is compulsory, i.e. it has to be set with a certain value.

19.3.6 "balanceif" preference keys

printers
strlist ""

(HELIOS Admin option Printer)

A string which contains, separated by commas and without any spaces, the logical (UNIX) printer names of those devices which form a printer group for balancing print loads.

ForcePrintEnv
bool TRUE

This preference induces the specified output interfaces to use the balance queue's PPD, settings and security settings.

19.3.7 "timeif" preference keys

printtimes
strlist ""

(HELIOS Admin option Start Time)

With this preference a list of so-called "time spec" strings for a time queue can be defined. This type of printer queue immediately forwards the jobs to the Hold Queue during the specified date/time. Outside the defined times the jobs remain in the time queue until the next date/time specification is reached.

Usage:

[!]Duration/StartTime[,StartTime...]
[/DayOfWeek[,-DayOfWeek...]||DayOfMonth
[,-DayOfMonth...][/Month[,-Month...]]]

Consider the following for the single specifications:

Duration Hours:Minutes required
StartTime Hour:Minute required
DayOfWeek Sun-Sat optional
DayOfMonth 1-31 optional
Month 1-12 optional

An "!" character (exclamation mark) before the following specifications negates the entry, i.e. date/time in which the time queue must not forward jobs to the Hold Queue.

Example:

3:0/15:0/Tue,Wed,Sat,Sun

In the above given example, print jobs are immediately forwarded to the Hold Queue on Tuesdays, Wednesdays, Saturdays and Sundays from 15.001 for 3 hours (and
0 minutes).

Of course, you can specify a set of several "time spec" strings in order to obtain several modes of operation from the same time queue.

Note: By means of HELIOS Admin you can only define one "time spec" string at a time.
Note: Entries in this preference specify when a print job
is forwarded to the Hold Queue. Therefore, setting printtimes is only meaningful if a Hold Queue is already set.

19.3.8 "cloneif" preference keys

clones
strlist ""

(HELIOS Admin option Duplicate to Printer)

Specifies a comma-separated list of printer queues to which print jobs are cloned (duplicated) from the original queue.

19.4 Service Controller preference keys

The following keys require a service restart to take effect:

Key: Services/<my_service>/<preference>
ExecPath
str ""

Specifies the path to the server executable. ExecPath can be either an absolute path (starting with "/") or a relative path. A relative path is interpreted relative to the HELIOS installation directory (e.g.: "/usr/local/helios").

Enabled
bool TRUE

Specifies whether the service is to be started by the command "srvutil start all".

DependsOn
strlist ""

Specifies a list of services that <my_service> depends on. If <my_service> depends on <your_service> then <my_service> will always be started after <your_service> is started, and it will be stopped before <your_service> is stopped.

OptDependsOn
strlist ""

Specifies a list of services that <my_service> optionally depends on. The only difference to DependsOn is that optional dependencies are ignored if the specified service is not installed.

The next three preferences control the automatic restart feature of the HELIOS Service Controller:

RestartDelay
int 10

Specifies the time in seconds that the HELIOS Service Controller waits before it restarts a service.

RestartLimit
int 10

Specifies the maximum number of restarts for a service before it is disabled.

RestartReset
int 60

Specifies the time in seconds during which the HELIOS Service Controller tries to restart a service (according to the value specified in the RestartLimit preference) before resetting the counter to "0".

19.5 Desktop server preference keys

The following keys require a service restart to take effect:

Key: Programs/desksrv/<preference>
closedelay
int 60

Specifies the batch close delay in seconds for closing desktop database after a "dt" command has been issued.

When multiple "dt" commands are being used the benefit is that the desktop server database is still open so that additional commands will be processed faster.

maxdesktop
int 128

Specifies the maximum number of network volumes that can be opened by Mac users on the File server simultaneously.

The default is 128 volumes. Each open volume is only counted once, even if it has been opened by more than one user. The absolute maximum value is 450, but the achievable maximum may be limited by the maximum number of open files for the "desksrv" process allowed by the host. This limit is normally set by "desksrv" for itself automatically. In case of problems, refer to "limit" and "ulimit" in your UNIX documentation for details about how to increase the limit manually for your host.

SQLFlushDelay
int 60

Specifies the time in seconds before the live desktop database is flushed. If the value is set to "0", all changes are written synchronously which results in bad performance.

UseSQL
bool TRUE

By default the new desktop database format is used for HELIOS volumes. The new format can be disabled globally when setting this preference to FALSE. The desktop database format can be set for individual volumes by use of the volume preference UseSQL in 19.1 "Volume preference keys".

19.6 Rebuild preference keys

Key: Programs/rebuild/<preference>
cleanorphans
bool TRUE

This preference causes resource orphans to be deleted each time a desktop rebuild takes place (see Resource orphans in 8.12 "rebuild"). This operation requires a certain amount of processing time.

twopass
bool TRUE

This preference induces the "rebuild" program to run two times: in the first session, "rebuild" tries to restore all already-known IDs on the volume and makes records of all conflicts. In the second session, all those files which have caused conflicts are allocated a new ID.

19.7 Authentication server preference keys

The following keys require a service restart to take effect:

Key: Programs/authsrv/<preference>
ypdir
str "/var/yp"

Directory containing the NIS password and group files. This preference needs only to be specified on a NIS Master host.
Please read the chapters 10.3.1 - 10.3.4 before setting up NIS.

ypmapdir
str "/etc"

Specifies, in a NIS configuration without separate "passwd" and "group" file, the directory that is used for the "passwd" and "group" maps.
Please read the chapters 10.3.1 - 10.3.4 before setting up NIS.

sysadmgroup
str SysAdm

HELIOS allows users with sufficient permissions to configure the HELIOS system from any workstation on the network in a convenient and secure way. For example, it can be used to set up users, groups, volumes, and printers, and re-schedule print jobs. Normally, only the system administrator is allowed to make any changes. Non-privileged users can inspect the configuration and the print job queue, but cannot change anything except delete their own print jobs.

Members of the special "system administrators" group can also use HELIOS Admin to make any changes they like, including printer configuration. However, these group members are not allowed to modify any information on users with an ID less than 100 (Note that the system administrator has a user ID of 0!).

prnadmgroup
str PrnAdm

Members of the special "printer administrators" group can use HELIOS Admin to manipulate print jobs from a workstation, i.e. they are allowed to:

queadmgroup
str QueueAdm

Members of the special "queue administrators" group can use HELIOS Admin to manipulate print jobs and queue configurations from a workstation. Thus, they have even more privileges than members of the "printer administrators" group that is described below. Queue administrators are allowed to:

wsadmgroup
str WSAdm

Members of the special "WebShare administrators" group can use WebShare to manipulate WebShare user and sharepoint configurations from any workstation on the web.

guest
str "nobody" (HP-UX: "hnobody")

Specifies the user name which is automatically assigned to guest users. The name is invisible to guest users, it is solely used to assign an entry for guests in the user list. If this preference is specified, the authentication server automatically supports guest access to available volumes. Otherwise, guest access to available volumes is not possible.

Note: The AFP server preference enableguest must be activated (see EtherShare manual).
NameServices
str "local"

(HELIOS Admin option Authentication Services)

Defines the name services which are used. In addition this preference defines the order of the name services.

Possible values are: local, NIS, PDC, LDAP, MACOSX.

FlushTime
int 120

Defines the time interval (in sec.) after which the "authsrv.cache" file is flushed.

RSABits
int 1024

Determines the cipher strength for the password encoding.

The minimum value is 640. For use with the Apple iPhone specify 640, otherwise a JavaScript time-out error occurs.

Note: The following preferences are only used if AD/PDC is active.
PDCAuthDir
str "HELIOSAUTH"

Defines the name of the special network share created by "heliosauthcreate.exe". This preference must only be set if "heliosauthcreate.exe" was called with the -s <share> option to create a non-default share.

PDCDomain
str "AUTHDOM"

(HELIOS Admin option Domain Name)

Specifies which domain is used for authentication.

PDCServer
str ""

(HELIOS Admin option Primary Server)

Specifies which PDC is used for authentication.

PDCUser
str "PDCUser")

(HELIOS Admin option Local Template User)

Specifies the name of the local template user, which is used for automatically assigned user IDs.

PDCLockDir
str "ADMIN$"

Specifies the sharepoint name which is used by the authentication server.

PDCAdminName
str "HeliosAdmin"

(HELIOS Admin option Admin Name)

Specifies the login name which is used for accessing the PDC.

PDCAdminPasswd
str ""

(HELIOS Admin option Password)

Specifies the password which is used for accessing the PDC. The password is stored encrypted.

PDCUserFirstId
int 2000

(HELIOS Admin option First User ID)

Defines the lowest value which will be used during dynamic user ID assignment.

PDCUserLastId
int 2400

(HELIOS Admin option Last User ID)

Defines the highest value which will be used during dynamic user ID assignment.

PDCGroupFirstId
int 2000

(HELIOS Admin option First Group ID)

Defines the lowest value which will be used during dynamic group ID assignment.

PDCGroupLastId
int 2400

(HELIOS Admin option Last Group ID)

Defines the highest value which will be used during dynamic group ID assignment.

Note: The ranges for dynamically assigned user/group IDs must not overlap with any user/group IDs used on the UNIX system.

19.8 mDNS server preference keys

The following keys require a service restart to take effect:

Key: Programs/mdnssrv/<preference>
interfaces
str ""

This preference allows limiting the interfaces if only specific interfaces should be used on the HELIOS mDNS server.

hostname
str ""

(HELIOS Admin "MDNS" option Server Name)

The default mDNS server name is adapted from the server's host name. This preference allows specifying a custom host name used for mDNS if a different name is required.

19.9 mDNS proxy server preference keys

The following keys require a service restart to take effect:

Key: Programs/mdnsproxysrv/<preference>
remoteproxy
str ""

(HELIOS Admin "MDNS" option Remote Proxy)

String that contains the address of a remote proxy server, whose internal services and service registrations should be adopted locally (e.g. ankh.helios.de).

TelnetPort
int 2026

Specifies the "telnet" port number. If not specified, the default port number (2026) is used.

RemoteRegistrations
bool FALSE

(HELIOS Admin "MDNS" option Remote Telnet Registrations)

Specifies if a service that is not locally logged-in is allowed to register new services.

ipaccess
str ""

(HELIOS Admin "MDNS" option IP Access)

Specifies the name of an (optional) IP access list. Usually this preference is not specified.

RemoteAccess
bool TRUE

Allows access from a remote computer.

Important: Do not set this preference to FALSE unless you intentionally wish to disallow all remote connections to the server!
forward
str ""

String that contains a list of IP addresses (of local interfaces that allow mDNS forwarding among each other).

For example, if you have a machine with 4 interfaces, and routing should be allowed between three of them, specify the addresses of the three interfaces with this preference.

Note: The entry "0.0.0.0" completely switches off forwarding between the interfaces completely.

19.10 Notification server preference keys

The following keys require a service restart to take effect:

Key: Programs/notifysrv/<preference>
TelnetPort
int 2017

Specifies the "telnet" port number. If not specified, the default port number (2017) is used.

19.11 DHCP server preference keys

The following keys require a service restart to take effect:

Key: Programs/dhcpsrv/<preference>
dynage
int see text

HELIOS clients can optionally be configured for dynamic IP address allocation, rather than manually configuring the address on each client. "HELIOSDIR/var/conf/ethers.pcs" is used in this case to store a list of client IP addresses which have been automatically allocated. Dynamically allocated IP addresses will be reused by the server for other clients if they are not used by the original client for dynage days.

The default for dynage is 62 (days). If dynage=0, the server never reuses IP addresses which have been dynamically allocated.

gateway
str (e.g: "172.16.0.1")

(HELIOS Admin option GAteway for DHCP Client)

HELIOS clients can be optionally configured for dynamic IP address allocation, rather than manually configuring the address on each client. This preference specifies the name(s) and/or IP address(es) of one or more IP routers on the network (if any).

HELIOS clients configured for dynamic IP address allocation are then allocated to the gateway in this list which is appropriate to their IP address. The gateways list has the same function as the "gateway" entry in the local HOSTS file, which is not present if the client is configured for dynamic IP address allocation.

logserver
str <ip-addr or name>

Specifies the IP addresse(s) of those syslog servers that are to be given to DHCP clients. More than one IP address can be specified by comma-separation.

primaryage
int 60

Specifies the time interval (in seconds) in which a secondary boot server synchronizes the data with the primary boot server. At each client boot request this synchronization is intended to be carried out if at least primaryage time has passed after the last synchronization.

primarydownage
int 300

Has the same effect as primaryage (see above), but takes effect only if the primary boot server fails.

bootpsyslogs
bool FALSE

Specifies if an error message is written to the "syslog" file when the "Ethernet-to-IP address" mapping is missing at BOOTP protocol requests.

dns
strlist ""

Forms the list of one or more IP addresses of the servers which can be used. It is transferred to the client via DHCP. By default, the server uses the information from the local "/etc/resolv.conf" file.

dnsadd
str ""

Template which is used to add a new IP address to the "nsupdate" program. The default is:

update add %h.%d. %t in a %a
update add %r.in-addr.arpa. %t in ptr %h.%d.

The "% escapes" are replaced as follows:

%h Host Name
%d DNS Update Domain
%a IP Address
%r Reverse IP Address
%t DNS TTL

For more information on "nsupdate" see the respective UNIX manual pages.

dnsdel
str ""

Template which is used to delete IP addresses to the "nsupdate" program. The default is:

update delete %h.%d. in a
update delete %r.in-addr.arpa. in ptr

The "%escapes" are the same as those described in dnsadd.

dnsidletime
int 120

Stops the "nsupdate" program if it has been idling for the specified amount of time (in seconds). If necessary, it is started again.

dnsttl
int 3600

Time (in seconds) how long a DNS entry is allowed to remain in the cache.

dnsupdate
str "nsupdate"

Program which is used for dynamic DNS updates. This is part of the UNIX named DNS bind daemon packets. The program is called in a pipe and controlled by the dnsadd and dnsdel templates.

leasetime
int 57600

Specifies the DHCP lease time (in sec.) for an IP address.

flushtime
int 1800

Defines the time span (in sec.) the data is flushed from memory into the "ethers.pcs" file after a change in the internal DHCP data.

RemoteAccess
bool FALSE

If set to TRUE, access to the DHCP server service port (2027) is enabled to remote users (subject to the restrictions in the ipaccess list). The default is that access to the DHCP server service port is only enabled for users on the same host.

ldapurl
str ""

Specifies the complete LDAP URL that is to be given to DHCP clients.

searchdomain
str ""

Specifies the domain search list used when resolving hostnames with DNS that is to be given to DHCP clients.

The following preferences are set with the PCShare key:

Key: Programs/pcshare/<preference>
Note: Even if you do not have installed and licensed PCShare you may set these preferences, or use HELIOS Admin to set them.
scopeid
str ""

(HELIOS Admin option Scope Identifier)

Specifies the scope ID that is to be given to DHCP clients.

nameserver
str ""

(HELIOS Admin option WINS IP Address)

Specifies the NetBIOS name server that is to be given to DHCP clients.

nameserverbackup
str ""

Specifies the NetBIOS backup name server that is to be given to DHCP clients.

19.12 HELIOS Admin server preference keys

The following keys require a service restart to take effect:

Key: Programs/heladmsrv/<preference>
IpAddress
str 0.0.0.0

If a host has more than one network interface, the interface, which provides the service ("heladmsrv") can be specified by use of this preference. If this preference is not set, the service is provided on all interfaces.

AllowSavePassword
bool FALSE

If set to TRUE, an additional checkbox becomes available in the HELIOS Admin login dialog which allows saving the password.

Port
int 2006

Specifies a different port for client/server communication. In the case that "heladmsrv" issues the following error message to the system log file, another service is already using this port:

bind port 2006: Address already in use
LogHttpErrors
bool FALSE

The HELIOS Admin client displays all HTTP protocol errors in a dialog box. Some error messages are suppressed by the HELIOS Admin client, because they are only destined for the internal workflow of the client. With this preference set to TRUE, they are additionally written to the system log file and therefore being logged.

LogSessionErrors
bool FALSE

The HELIOS Admin client displays all administration session errors in a dialog box. Some error messages are suppressed by the HELIOS Admin client, because they are only destined for the internal workflow of the client. With this preference set to TRUE, they are additionally written to the system log file and therefore being logged.

SessionLifetime
int 3600

This preference specifies (in seconds) how long the server waits for HELIOS Admin client requests. If no client request has occurred during this time interval, the server assumes that the HELIOS Admin client has been unexpectedly closed and terminates.

Important: If a Directory Agent is active and a Service Agent uses the scope that is NOT supported by a Directory Agent, its registrations are not available.
AuthTimeout
int 4000

This preference specifies the maximum response time (in milliseconds) for the authentication server. An authentication server checks the validity of a password. For details see 10 "The authentication server".

ipaccess
str "var/conf/ipaccess"

Allows specifying an alternative path to the "IpAccessFile".

logdenied
bool FALSE

If set to TRUE, this parameter lets "heladmsrv" append a record to the system messages if, due to the IP access list, access to one or more users has been denied.

FilterUid
int 0

The value specified with this preference is registered with the key ":du#" in the "printcap" file.

NBPLookupCount
int 1

This preference controls how many NBP lookups are done to find printers. If a printer does not appear in the Name: pop-up of the AppleTalk printer settings, this preference can be set to a higher value.

1
Note that for "StartTime" the 24-hour code must be used!


© 2008 HELIOS Software GmbH