CLIENT

Usage: CLIENT <profile> <command> [<parameters>]

The client command set lets you add client profiles for the server. A profile is a set of commands that set certain restrictions on users as they try to join the server. You create a profile and add a user@host mask. 
The server will try to match a user against each enabled profile until it succeeds or runs out of profiles. Then it will use the settings for the first profile it matched or it will deny the user access. More restrictive profiles should be placed before more open profiles. 
As an example if you allowed all users to join your server (ConferenceRooms default) but wanted to set up a special message for all company employees, you would create a profile called "a-company" with a hostmask set for all the user addresses in your company. 
CR would see these users as they join and match them against the hostmask in the first profile, if they didn't match it would go to the next until it reached the "z-default" profile, which would allow them on.

ADD - Add a client profile to the server.

DEL - Delete a specified client profile.

DISABLE - Disable the profile while saving the information.

ENABLE - Turn on the profile.

LIST - List the information in a client profile.

MASK - Add or delete masks in a client profile.

RENAME - Rename a profile.

SET - Set specific client profile options.

VHOST - Manage Virtual Hosts.

Example:

/as help client <command>

Specific client profiles allow you to customize messages and modes for specific types of users. The most obvious example of this is sending message of the days in different languages for clients from different countries.

Usage: CLIENT <class> ADD

Adds a new client profile. A profile when added is disabled until you specifically enable it, which will allow you to finish your settings before using it. Note: The Default client is called z-default.

Example:

/as client ConferenceRooms add

This is the first step to creating a client profile. Then you need to add a mask for it and enable it.

Usage: CLIENT <class> DEL

Allows you to delete a profile you no longer want.

Example:

/as client ConferenceRooms del

This permanently deletes a profile. If you just want to make it temporarily inactive, disable it. Once deleted you will have to completely recreate the profile to use it again.

Usage: CLIENT <class> DISABLE

The disable command disables a client profile without deleting the information.

Example:

/as client default disable

This allows for temporarily disallowing connections to a client class without forcing you to recreate the entire class when you once again want to allow clients to connect.

Usage: CLIENT <class> ENABLE

The enable command will re enable

Example:

/as client default enable

This allows you to enable a client class that is currently disabled or not functioning.

Usage: CLIENT <class> LIST

Lists all the parameters of the specified client profile.

Example:

/as client ConferenceRooms list

This is useful to check over how a profile is configured.

Usage: CLIENT <class> MASK <command> [<mask>]

These commands allow you to set masks for a client profile. When clients login, they will be compared to the set masks. The first mask they match will control which profile they get.

ADD - Add a Client host mask

DEL - Delete a specified Client host mask

LIST - List all specified Client host masks

Examples:
 
/as help client mask <topic>

In order to enter the chat network a user must match one of the enabled client masks. Unless you disable the z-default profile, everyone will match it so everyone can join (unless there are klines or other things blocking them specifically). 
They will receive the modes and the MOTD associated with the first profile they match. The above example would match anyone from conferencerooms.org. An addy such as *@*.aol.com would match all AOLers.

Usage: CLIENT <class> MASK ADD [<mask>]

This allows you to add a hostmask to the specified Client Class. 

Examples:
 
/as client ConferenceRooms mask add *@*.conferencerooms.org

The mask is in the form of userid@domin *@*.conferencerooms.org will let anyone on the server from the conferencerooms.org domain. *@127.0.0.1 will let anyone on from localhost. userid's can be handy to descriminate against which page a user is coming from on the web chat client, so you could have support@* and sales@* if your web chat userid was set to support or sales.

Usage: CLIENT <class> MASK DEL [<mask>]

This will delete the specified mask from a client class. 

Examples:
 
/as client ConferenceRooms mask del *@conferencerooms.org

The mask must match exactly to a mask that was placed using the CLIENT MASK ADD command. A wider mask will not delete masks that are contained in that mask.

Usage: CLIENT <class> VHOST LIST

Lists all the configured hostmasks for the specified profile.

Examples:
 
/as client ConferenceRooms mask list

Usage: CLIENT <class> RENAME <name>

Because ConferenceRooms matches against the profile name you may want to rename it to set a different order for matching. 

Example:

/as client z-default rename zz-default

As a general rule, if a client definition has a very specific mask, prefix the name with an a- and if it is very general prefix it with a z-.

Usage: CLIENT <class> SET <command> [value]

Set specific options for your client profile.

CHAN - Set a client class default channel.

LIMIT - Max Users in class.

MODE - Set the default modes for users.

MODELOCK - Same as MODE but locks the defaults.


Example:

/as help client set <command>

Usage: CLIENT <class> SET CHAN <channel>

This command allows you to set a default channel that all members of the specified client class will automatically join when they log into the chat server.

Example:

/as client ConferenceRooms set limit 100

Very nice command when used with host matching to allow you to specify default channels for groups to automatically join.

Usage: CLIENT <class> SET LIMIT <number>

This command limits the number of clients that can connect with this profile. Warning: If you do not have any other profiles defined then the number set will be the maximum number of users allowed on the server. You will probably want your z-default to allow as many connections as you can, but remember if a client hits an earlier limit, then they cannot get onto your network. 

Example:

/as client ConferenceRooms set limit 100

You can use this to limit certain types of users so that other preferred users are more likely to be able to connect. Or you could set your z-default to a smaller value than your total allowed client amount. 
Then you can have an earlier profile allow on your full amount so that people in that profile can always connect since space is reserved for them. You'd want to place your profiles and set your limits carefully to arrange that.

Usage: CLIENT <class> SET MODE [+|-<modes>]

This option will set a specific mode on a client when they log onto your server. To view all the modes available for a client please refer to the user modes section listed in server commands for all users.

Example:

/as client Z-default set mode +ix

This becomes a user's starting modes. They can alter them as they choose, except in ways that conflict with a modelock. It is a good idea to start users with a general set of modes that most of them will like. This gets new users started well, and they won't change their modes until they know enough to do so deliberately. 
On large networks you will probably want to include +i and +x as part of the initial mode. These modes help protect people from spam or other annoyances. Other good modes to consider are +w, if your network tends to send useful information through wallops and +L if you prefer your users to start off with profanity filters.

Usage: CLIENT <class> SET MODELOCK [+|-<modes>]

Much like the MODE option but this locks modes for the clients. This means that a user cannot remove the modes specified for that client class. For example, if you don't want users to be able to see wallops, you could modelock them -w. 

Example:

/as client z-default set modelock +ix-ws

Modelocks are useful when you want to restrict some or all of your users. If you don't want your users able to turn off host mask munging (+x) then you can mlock it for them. Network operators can change their modes despite whatever modelock might apply to their client class. This means that mlocking something like -w, turns them into an oper-only mode.

Usage: CLIENT <class> VHOST <command> [<mask>]

Client classes support a virtual hosting feature set. This allows a single chat and web server to look like several servers. Users can be separated based on how they connect to the chat or web server and can be presented with distinct views of other users and channels.

ADD - Add a client virtual host IP

DEL - Delete a specified client virtual host IP

LIST - List all specified client virtual hosts

Examples:
 
/as help client vhost <topic>

Please see Zones and Virtual Hosting for more information.

Usage: CLIENT <class> VHOST ADD [<host_mask>]

Adds the virtual host address to the specified client class.

Examples:
 
/as client ConferenceRooms vhost add 10.10.52.198

Usage: CLIENT <class> VHOST DEL [<host_mask>]

Deletes the virtual host address from the specified client class.

Examples:
 
/as client ConferenceRooms vhost del 10.10.52.198

Usage: CLIENT <class> VHOST LIST

Lists all the configured VHosts for the specified profile.

Examples:
 
/as client ConferenceRooms vhost list