# maxusers command

The maxusers command displays the number
of licensed D3 users on the system, and/or sets the system in single
or multiuser mode.

## Syntax

```
maxusers {(options}
```

## Parameter(s)

| options | a | Invokes the where command with the a option. |
| --- | --- | --- |
| c | Indicates compatibility output, which produces the original style of output. Also displays the number of weeks remaining on temporary activations (for UNIX 7.4 or above and Windows 7.5 and above). | |
| delay | Integer number that defines the grace period delay in seconds before logging users off when entering single-user mode. The default is five seconds. | |
| e | Displays entire pool list. | |
| f | Logs off users currently logged on before entering single-user mode. A warning message is broadcast unless the w option is also specified. Unless the u option is specified, a prompt will be presented on the line issuing the command for each line currently logged on before logging it off. The available responses are:y: Yes. Logoff the line. n: No. Do not logoff the line. Move onto the next line.i: Information. Show a who, where, and if applicable, an nt_pinfo for the line and then re-prompt.q: Quit. The system is returned to multiuser mode. | |
| l | Suppresses the message log in the system-errors file when changing the mode. | |
| m | Sets multiuser mode. The number of allowed users is set to the maximum number of user licenses allowed by the pool. | |
| m### | For UNIX: Sets the maximum number of licenses used in a given VME or allows even distribution across multiple VMEs. The system does not remember to what the ceiling was last set. Therefore, when switching from single-user mode back to multiuser mode, if no ceiling is specified, then it will set it at the maximum. For Windows: Not Supported | |
| o | Invokes the where command with the a and o options. (User must set the a option). For example: ```
maxusers (ao
``` | |
| p | Prints the results. | |
| q | Quiet mode suppresses all output to the terminal. | |
| r | Sets single-user mode and stops all new RPC clients from connecting to D3. | |
| s | Sets single-user mode. | |
| u | Unconditionally logs off users currently logged on when entering single-user mode (valid only with the f option). | |
| w | Suppress the broadcast of the warning message indicating that the system is going to single-user mode. | |
| z | Invokes the where command with the a and z options. (User must set the a option). For example: ```
maxusers (az
``` | |

## Description

The maxusers command can accept the a and o option of the where command and execute a where.

The single-user mode is defined as the state where only the process that executes the command
 remains on the system.

On Unix platforms, line 0 is allowed on even if the system is in single user mode.

All other ports are optionally logged off before entering the
single-user mode, after sending two warning messages, separated by
an optional grace delay.

Note: Confirmation is required before logging a user off unless the u option was
 specified.

A message is logged in the errors file when entering single-user or multiuser mode.
Additionally, if a user attempts to logon after the maximum allowed
users limit has been reached, an error message is logged to the errors
file.

Warning: Use with *extreme caution* on
a live system.

## Example 1

To show current UNIX settings:

```
maxusers

Pool Name Max Licenses Used Licenses Users Allowed Weeks
User 100 2 100 0
Server 1 1 1 0
FlashCONNECT 50 0 50 0
ODBC 8 0 8 0
Phantoms 25 0 25 0
```

## Example 2

To show current Windows settings:

```
maxusers

Pool Name Max Licenses Used Licenses Users Allowed Weeks
User 8 1 8 0
Server 1 1 1 0
FlashCONNECT 1 0 1 0
ODBC 8 0 8 0
Phantoms 14 1 14 0
RPC Clients 8 0 8 0
```

## Example 3

To set single-user mode and log
all users off in 30 seconds:

```
maxusers (sf30

Pool Name Max Licenses Used Licenses Users Allowed Weeks
User 100 2 1 52
Server 1 1 1 52
FlashCONNECT 50 0 50 52
ODBC 8 0 8 52
Phantoms 25 0 25 52
```
This allows a grace period of 30 seconds after issuing the first
warning message, before logging users off.

## Example 4

To switch to multiuser mode with
a ceiling from a single-user mode:

```
maxusers (m50

Pool Name Max Licenses Used Licenses Users Allowed Weeks
User 100 2 50 52
Server 1 1 1 52
FlashCONNECT 50 0 50 52
ODBC 8 0 8 52
Phantoms 25 0 25 52
```
Note: This can only be used from a single-user mode.

## Example 5

To switch back to multiuser mode
from a single-user mode:

```
maxusers (m

Pool Name Max Licenses Used Licenses Users Allowed Weeks
User 100 2 100 52
Server 1 1 1 52
FlashCONNECT 50 0 50 52
ODBC 8 0 8 52
Phantoms 25 0 25 52
```

## Example 6

To enter the single-user mode, log all users off unconditionally (f and
 u), immediately without any warning (w), and in quiet mode
 (q) so that no output displays type:

```
maxusers (swufq
```

## See also

- [coldstart command](https://d3codex.com/tcl/coldstart-command/)
- [d3 command](https://d3codex.com/unix/d3-command/)
- [system-coldstart macro](https://d3codex.com/tcl/system-coldstart-macro/)
- [uf070 user exit](https://d3codex.com/pickbasic-flashbasic/uf070-user-exit/)
- [user-coldstart macro](https://d3codex.com/tcl/user-coldstart-macro/)
- [what command](https://d3codex.com/tcl/what-command/)

---
Source: https://d3codex.com/tcl/maxusers-command/ - part of the D3Codex reference.