HELIOS Base UB User manual
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 7 "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.Sets the Macintosh AFP volume name. The setting reflects that of the AFP Name field in the HELIOS Admin Volumes configuration window.
Sets the PCShare SMB volume name. The setting reflects that of the SMB Name field in the HELIOS Admin Volumes configuration window.
Specifies the volume password (currently only supported on Mac). The setting reflects that of the Password field in the HELIOS Admin Volumes configuration window. The password is specified as MD5 hash code. It can be batch generated using "authutil" (see 10.2 "authutil").
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 Volumes configuration window.
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 Volumes configuration window.
With this flag set to TRUE, the particular volume is published for Macintosh clients. The setting reflects that of the Macintosh visible checkbox in the HELIOS Admin Volumes configuration window.
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 Volumes configuration window.
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 Macintosh clients, PC clients, and UNIX servers. The setting reflects that of the Unicode/UTF8 checkbox in the HELIOS Admin Volumes configuration window.
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 Volumes configuration window.
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 Volumes configuration window.
Specifies a list of groups which are allowed access to this particular volume. The setting reflects the entries in the Group field in the HELIOS Admin Volumes configuration window.
Specifies the file name of the IP access list that makes the particular volume visible for clients which have one of the IP numbers on the IP access list.
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 Volumes configuration window.
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 Volumes configuration window.
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 Volumes configuration window.
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.
This flag specifies whether or not the server allows record locking between multiple PCShare clients.
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").
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.
Specify 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.
Specify 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.
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.
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.
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.
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.
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.
Causes the print server to "pretend" to have no font installed, which would the client application induce to include all needed fonts in the print job.
Specifies an error queue out of the already installed printer queues. It corresponds to Error Queue in the HELIOS Admin Printer configuration window.
Specifies the PCShare export name of the particular printer. It corresponds to the SMB Name field in the HELIOS Admin Printer configuration window.
Specifies the Windows printer driver name. This preference corresponds to the Driver Name field in the HELIOS Admin Printer configuration window.
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.
Specifies the name under which the TCP printer is registered by SLP, 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.
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.
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.
Specifies whether the particular printer is published for PAP clients, i.e. for Macintosh clients. The setting reflects that of the Macintosh - PAP checkbox in the HELIOS Admin Printer configuration window.
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.
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.
This preference specifies a comma-separated list of scopes under which the printer is registered via SLP. Otherwise, the scopes preference is taken either from "papsrv" or - if not even available - from the local "slpsrv".
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.
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".
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.
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.
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.
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 EtherShare, but you must not use resolve in conjunction with the standard EtherShare interface programs, because all references will be included twice and the job will fail.
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.
The "papsrv" induces Apple's LaserWriter printer driver to spool the jobs directly to the selected EtherShare queue by default.
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.
Determines whether printer errors are reported back to the originator of the print job via e-mail. 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 and SMTPSender (see above) must be set up correctly for e-mail notification to work.Specifies the mail domain for print job e-mail notification. E-mail are sent to <username>@<SMTPDomain>.
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.
This switch causes the printer's page count to include the number of banner pages in the total amount of pages.
This preference determines that the banner page is output after the print job has been terminated on the printer.
Causes the printer to output a banner page before the print job (compare bannerlast above).
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.
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.
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.
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.
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:
With the ignoreprocsetresolveopt flag set, the next (second) spooler ignores information about included procsets only.
With the ignorefontresolveopt flag set, the next (second) spooler ignores information about included fonts only.
With the ignoreincluderesolveopt flag set, the next (second) spooler ignores information about included EPSF files only.
With the ignoreopiresolveopt flag set, the next (second) spooler ignores information about resolved OPI-references only.
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.
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:
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 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)".
Value is the name of a scripting table, e.g. SJIS. This implies auto detection of PC or MAC originated PostScript jobs.
Specifies the Internet number of the printer in the TCP/IP network (or of the printer's terminal server, if any).
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.
Specifies the name of the remote printer on the remote host, as stated in the "HELIOSDIR/var/conf/printcap" file.
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.
Specifies whether a separate communications channel for status messages with the address <port+1> is provided.
Specifies the path (including file name) of the Shared Memory "key" file. The file must already exist. The RIP must be configured with the same path.
The RIP and the "Shared Memory" interface program use the key file's "inode" to create a unique numeric key, and do not modify or write to the file in any other way. Accordingly, any existing file (such as "/bin/ls") can be used for this purpose. See the description of "ftok" in your UNIX documentation for related information.
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.
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.
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.
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.
This preference will only be recognized if dir is specified as well. This preference is called as soon as "diskif" has successfully resolved the print job.
<expected print job size (in bytes). The stated value is often smaller than the actual size>
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.
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.
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.
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.
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.
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
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.Specifies a comma-separated list of printer queues to which print jobs are cloned (duplicated) from the original queue.
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").
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.
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.
Specifies the time in seconds that the HELIOS Service Controller waits before it restarts a service.
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".
Specifies whether the server works as a Directory Agent. If this preference is not set, and more than one network interface is configured, then the server becomes a Directory Agent (8 "Service Location Protocol (SLP)"). The setting reflects that of the SLP Directory Agent buttons in the HELIOS Admin Server Settings configuration window.
This preference contains the scopes which this server uses for SLP registrations. The setting reflects that of the SLP Scope field in the HELIOS Admin Server Settings configuration window.
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.This preference expects a comma separated string which contains the IP addresses that are to be used by SLP. If existing, the value is read out when the "slpsrv" is started, and the automatic detection of interfaces is bypassed.
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.
Specifies the maximum number of network volumes that can be opened by Macintosh 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.
This preference causes resource orphans to be deleted each time a desktop rebuild takes place (see Resource orphans in 7.10 "rebuild"). This operation requires a certain amount of processing time.
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.
Directory containing the NIS password and group files. This preference needs only to be specified on a NIS Master host.
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!).
Members of the special "printer administrators" group can use HELIOS Admin to manipulate print jobs from a workstation, i.e. they are allowed to:
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:
Members of the special "WebShare administrators" group can use WebShare to manipulate user and sharepoint configurations from any workstation on the web.
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.
Defines the name services which are used. In addition this preference defines the order of the name services.
Note: The following eight preferences are only used if
AD/PDC is active.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.
If set to TRUE, an additional checkbox becomes available in the HELIOS Admin login dialog which allows saving the password.
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:
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.
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.
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.
Specifies the SLP (Service Location Protocol) URL of the HELIOS Admin server that is to be registered.
While logging on to the SLP server, each process sends along a "lifetime" value (in seconds). At intervals, the SLP server verifies that each service is still running. If so, it renews the lifetime. Otherwise, the SLP server removes the process registration from its list.
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.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".
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.
|© 2005 HELIOS Software GmbH|