Start-up Command: Difference between revisions
(Uploaded, added, and positioned help image) |
(Heavily edited the startup command page as it was in terrible shape) |
||
Line 1: | Line 1: | ||
You may use BR in combination with a '''start-up''' [[command]]. It can be executed only from the host [[operating system]]. | You may use BR in combination with a '''start-up''' [[:Category:Commands|command]]. It can be executed only from the host [[Wikipedia:Operating system|operating system]]. | ||
For example, in Windows: | |||
#Click Start → Run | |||
#Type in '''C:\BR\BR.exe -45 @alternateUser''' and press <ENTER> | |||
The effect of the above command will be: | |||
#BR will be started | |||
#The workstation ID will be 45 (speceified by the -45 parameter) | |||
#Instead of the currently logged in Windows user, an alternative name will be used, in this case '''alternateUser''' | |||
The above command assumes that the BR executable is located in the directory C:\BR | |||
==Syntax== | |||
The complete syntax diagram of the BR command is as follows: | |||
{| border="1" | |||
| [[Image:HELP0066.jpg|left]] | |||
|} | |||
==Parameters== | |||
The top path in part <1> of the syntax diagram above starting with '''br''' represents Unix and Linux versions of BR. It must be used in lowercase letters to start up BR from either of these systems. | |||
The BR | The bottom path <2> represents DOS and DOS NetWork versions. '''BR''', in either uppercase or lowercase letters, must be specified. | ||
In part <4>, a complete "statement" or "command" may follow the br keyword. It will be executed as soon as BR is entered. The use of quotation marks around the command or statement is not required, but it is highly recommended. | |||
The '''-wsid''' parameter represents the workstation ID. It may be a one- or two-digit number from 01 to 999. If no -WSID parameter is specified, BR automatically tries to assign a workstation ID of 1 to the session. | |||
A plus symbol (+) may optionally follow the -WSID parameter to indicate that when the specified WSID is already in use, BR should increment accordingly until an available ID is found. If the plus symbol is followed by an increment parameter, it will be used when it is necessary to increment. The increment parameter may be any whole number from 0 to 999. If the plus symbol is used but increment is not specified, 1 is used as the incremental default. If no plus symbol is specified and the requested ID is already in use, an error results. | |||
The -file-ref parameter identifies the name of an alternate BR configuration (BRConfig.sys) file. This configuration file can contain important information that helps customize a number of configurable BR and application options for the user. The actual specification must consist of a dash (-) followed by a path (optional) and file name. If -file-ref is not specified, BR automatically looks for a file named [[BRConfig.sys]] and uses its contents as the configuration file. | |||
@UserName parameter may also be used to override the windows [[environmental variable]] [[UserName]] in the [[Login_Name$]] [[internal function]]. | |||
== | ==Comments and Examples== | ||
As BR32.exe is executed from the [[Wikipedia:Operating system|operating system]], it is operating system dependent. In the next example, BR is started on a [[Wikipedia:Microsoft Windows|Windows]] system. Immediately after BR starts up, the [[RUN]] command is executed and the MENU [[program]] begins to run: | |||
BR32.exe "RUN MENU" | |||
The | The BR command in the next example causes, BR to start up at the same time that it assigns a [[workstation ID]] of 42 and specifies altconfg.sys to be used as the [[BRConfig.sys]] file: | ||
br32.exe -42 -altconfg.sys | |||
The | The BR command in the next example causes a PROC command to be executed as soon as BR is started. It also assigns a WSID of 21 to the workstation, and it identifies ALT6.SYS as the alternate BRConfig.sys file: | ||
BR32.exe "PROC START" -21 -ALT6.SYS | |||
==Defaults== | |||
#Do not load BR as a memory-resident task. | |||
#Enter BR without executing a command or statement. | |||
#workstation ID assignment | |||
##assign a workstation ID of 01 on single-user systems | |||
##assign the workstation's hardware-dependent ID on Unix and Linux systems | |||
##assign according to sign-on order on Windows systems. | |||
#Access BRConfig.sys from the default directory. | |||
#Use the specified [[WSID]]. If already in use, return an error. | |||
#Use an increment of 1. | |||
#Assume that the configuration file is named [[BRConfig.sys]]. | |||
At startup the number of authorized users is displayed, in addition to the number of current users. | |||
<noinclude> | <noinclude> | ||
[[Category:Commands]] | [[Category:Commands]] | ||
[[Category:Start-up Commands]] | [[Category:Start-up Commands]] | ||
[[Category:Needs Help]] | [[Category:Needs Help]] | ||
</noinclude> | </noinclude> |
Revision as of 13:10, 14 December 2011
You may use BR in combination with a start-up command. It can be executed only from the host operating system.
For example, in Windows:
- Click Start → Run
- Type in C:\BR\BR.exe -45 @alternateUser and press <ENTER>
The effect of the above command will be:
- BR will be started
- The workstation ID will be 45 (speceified by the -45 parameter)
- Instead of the currently logged in Windows user, an alternative name will be used, in this case alternateUser
The above command assumes that the BR executable is located in the directory C:\BR
Syntax
The complete syntax diagram of the BR command is as follows:
Parameters
The top path in part <1> of the syntax diagram above starting with br represents Unix and Linux versions of BR. It must be used in lowercase letters to start up BR from either of these systems.
The bottom path <2> represents DOS and DOS NetWork versions. BR, in either uppercase or lowercase letters, must be specified.
In part <4>, a complete "statement" or "command" may follow the br keyword. It will be executed as soon as BR is entered. The use of quotation marks around the command or statement is not required, but it is highly recommended.
The -wsid parameter represents the workstation ID. It may be a one- or two-digit number from 01 to 999. If no -WSID parameter is specified, BR automatically tries to assign a workstation ID of 1 to the session.
A plus symbol (+) may optionally follow the -WSID parameter to indicate that when the specified WSID is already in use, BR should increment accordingly until an available ID is found. If the plus symbol is followed by an increment parameter, it will be used when it is necessary to increment. The increment parameter may be any whole number from 0 to 999. If the plus symbol is used but increment is not specified, 1 is used as the incremental default. If no plus symbol is specified and the requested ID is already in use, an error results.
The -file-ref parameter identifies the name of an alternate BR configuration (BRConfig.sys) file. This configuration file can contain important information that helps customize a number of configurable BR and application options for the user. The actual specification must consist of a dash (-) followed by a path (optional) and file name. If -file-ref is not specified, BR automatically looks for a file named BRConfig.sys and uses its contents as the configuration file.
@UserName parameter may also be used to override the windows environmental variable UserName in the Login_Name$ internal function.
Comments and Examples
As BR32.exe is executed from the operating system, it is operating system dependent. In the next example, BR is started on a Windows system. Immediately after BR starts up, the RUN command is executed and the MENU program begins to run:
BR32.exe "RUN MENU"
The BR command in the next example causes, BR to start up at the same time that it assigns a workstation ID of 42 and specifies altconfg.sys to be used as the BRConfig.sys file:
br32.exe -42 -altconfg.sys
The BR command in the next example causes a PROC command to be executed as soon as BR is started. It also assigns a WSID of 21 to the workstation, and it identifies ALT6.SYS as the alternate BRConfig.sys file:
BR32.exe "PROC START" -21 -ALT6.SYS
Defaults
- Do not load BR as a memory-resident task.
- Enter BR without executing a command or statement.
- workstation ID assignment
- assign a workstation ID of 01 on single-user systems
- assign the workstation's hardware-dependent ID on Unix and Linux systems
- assign according to sign-on order on Windows systems.
- Access BRConfig.sys from the default directory.
- Use the specified WSID. If already in use, return an error.
- Use an increment of 1.
- Assume that the configuration file is named BRConfig.sys.
At startup the number of authorized users is displayed, in addition to the number of current users.