Using command line parameters

This article shows an overview of available client command line parameters, which support scripted installation and configuration of the client and it's folders, e.g. when using the client in a headless mode and setting up folders by a third-party system using scripts or direct executable calls.

Passing command line parameters to PowerFolder

To pass parameters to PowerFolder:

java -jar PowerFolder.jar <parameters>

Command line parameters for client configuration

For the general configuration of the client there are some nice command line parameters.

Those parameters can also be combined with each other if necessary.

Setting the default folder path

To set the default folder path, where the client creates new folders:

"-b <path>"

Overview:

Specifying a configuration file

To specify the configuration file the client should start with:

"-c <clientname>"

The client will use <clientname> to create configuration files, keyfiles and others with that name in the same directory, where the configuration of the first client is located.

Viewing this help information

To show an overview of all command line parameters:

"-h"

Specify language file

To specify a language file the client should use:

"-f <langfile>"

Where langfile is the path to the file that has to be named like translation_XX.properties where <XX> is the country code.

Specify language

To specify the language to use:

"-g <countrycode>"

Where countrycode is the extension of the langfile (XX – see above).

Shutting down the client

To shut down the client:

"-k"

Setting the log level

Specify which level should be logged:

"-l <level>"

level can be on of:

SEVERE
WARNING
INFO
FINE
FINER

Starting the client minimized

To start the client minimized to the system tray:

"-m"

Starting in console mode

To start the client in console mode, eg. with disabled GUI:

"-s"

Setting Username and Password

To set a username and password:

 "-u <username>"
 "-p <password>"

Starting multiple instances of the client

To start a second instance of the client on the same machine, skipping the "already running" warning:

"-z"

Running the client on a terminal server under different user accounts

In that case it's recommended to place a desktop shortcut for all users on that machine and extending the executable the shortcut points to with the above mentioned parameter.

Running the client on the same machine under the same user account

In that case it's recommended to combine this parameter with the one to specify a configuration file and a default folder path to use (see below), so both instances will start up using a different configuration and different default folder path. Both instances will be running on the same machine then and will be able to find each other via network broadcasts using the local loopback adapter.

Command line parameters for folder configuration

Folders can also be created/removed using command line options.

Creating folders via command line

To create a a folder via command line:

"--createfolder" "key1=value1;key2=value2;key2=value2;..."

Example for creating a folder via command line using a custom transfer mode:

"--createfolder" "dir=D:\Data\MyFolder;name=MyFolder;syncprofile=false,false,false,false,5,true,22,0,m,Daily Backup at 10pm;backup_by_server=true;silent=true"

The above example creates a folder at the local directory D:\Data\MyFolder backed up daily at 10pm to the server where the client is connected to.

The available options exaplained:

Option	Description
dir	Specifies where the folder should be located. Example: `dir=D:\Data\MyFolder`
name	Specifies the name of the folder. This name will appear in the user interface as well as on the server, the client backups the folder to. Example: `name=MyFolder` If not specified the directory name will be used as folder name.
id	Specifies a unique folder ID which should be used for the folder. Example: `id=[ds88fEXSITINGID]` It is recommended to NOT specify the ID during folder creation. The client will generate a random generic ID automatically, which will be used to join the folder on an other client.
syncprofile	Specifies the transfer mode which should be used for the folder. Example: syncprofile=true,true,true,true,5,false,12,0,m,Auto-sync If not specified the transfer mode Auto Sync will be used by default. Transfer Mode Configuration is described in a separate article in our documentation.
dlscript	Specifies a script which should be executed when a new file has been successfully downloaded to the folder. Example: `dlscript=C:\Scripts\received.bat %1` Executing scripts after download is described in a separate article in our documentation.
backup_by_server	Specifies if the folder should automatically be backed up on the server the client is connected to. Example: `backup_by_server=true` The client will automatically backup folders to the server by default. If this should be disabled set `backup_to_server=false`.
silent	Specifies if the folder should be configured without user interaction. Otherwise a configuration wizard will be opened to assist the user. Example: `silent=true`

Options need to be separated by semicolons.

Removing folders via command line

Folders can also be created/removed using command line options. To remove a a folder via command line:

"--removefolder" "key1=value1;key2=value2;key2=value2;..."

To specify the folder to remove, the folder name, ID or the folder path can be used. Examples:

"--removefolder" "name=MyFolder"
"--removefolder" "id=[ds77X6d7834]"
"--removefolder" "dir=D:\Data\MyFolder"