Commandline Arguments

From Jin

To pass commandline arguments to Jin, simply add them at the end of the command you use to run Jin. For example:

~/chess/jin-2.14/jin [argument1] [argument2]

or

java -jar jin.jar [argument1] [argument2]

Each argument specifies a parameter name and a parameter value, separated by an equals sign (=). For example, color=blue is an argument with parameter name color and parameter value blue. When specifying a boolean parameter whose value is true you may omit the equals sign and the value. For example, nice=true and nice are equivalent.

Unless otherwise specified, the order of the arguments is not imporant.

Login arguments

These arguments are used as if you entered their values into the login dialog you get when Jin starts up. Note that some of the arguments make Jin obtain further values automatically, as documented, but you may always override this behaviour by setting the values you want explicitly.

login.server

The id of the server, possible values are currently icc and fics. Specifying this parameter makes Jin obtain the user to log-in with first by the last logged in user (if it's on the same server) and if that fails by the sole known user for that server (if there is indeed a sole known user). If you only have one user on the server, specifying this parameter is enough to login.

login.guest

A boolean parameter specifying whether you want to login as guest. Specifying this option makes Jin obtain further login parameters (hostname, port etc.) from the preferences of your guest account.

login.username

The username of the account you want to use. Specifying this parameter makes Jin obtain further login parameters (hostname, port, password etc.) from the preferences of the specified account. If the account is already known to Jin, specifying this parameter is enough to login.

login.password

The password. It is not recommended to use this parameter as it may be visible to other users of your computer.

login.savepassword

Remember the password for future logins.

login.hostname

The hostname of the server to connect to.

login.ports

A comma separated list of ports for Jin to connect on.

autologin

A boolean parameter specifying whether to login automatically, without waiting for the user to hit the "Login" button on the login dialog. If you just have one account on one server, you can pass just this parameter and have Jin login automatically. Note that Jin will ignore this parameter if it doesn't have enough login information (either inferred or specified by other parameters).

Examples

jin autologin

If you have just one known account on one server, this will log you in automatically.

jin login.server=icc

If you have just one known account on ICC, this will log you in automatically.

jin login.server=icc login.username=OrionsKnight autologin

If OrionsKnight is a known account on ICC, this will log you in automatically.

jin login.server=fics login.username=MAd

Selects the previously known MAd account in the login dialog (without logging in automatically).

jin login.server=icc login.username=bkb login.password=macsrule login.hostname=queen.chessclub.com login.ports=23,5000 autologin

Logs on the queen ICC server with the bkb account and macsrule password, forcing Jin to first try port 23, then (if it fails) port 5000.