Command Line

An ELS-Navigator launcher application is provided for each supported operating system. This launcher uses the embedded Java to execute ELS in the correct directory with the provided options that might not include the Navigator. If no options are provided the Navigator is executed with default options. ELS may be also be executed using only the ELS.jar and a Java JRE 19+.

All configuration files are in JSON format. They may be edited by hand however using the Navigator is recommended.

Remember to restart any running ELS instance or daemons as necessary when Library or security settings are changed.

Command Line Options

Options are case-sensitive.

• -a | --authorize [password] : The password required for authorized access when in -r | --remote mode and allowing STTY interactive access to a listener with one of the terminal Operations

• -A | --auth-keys [file] : Authentication keys for Publisher, Subscriber Listeners and Hint Server. Authentication keys may be used instead of requiring a specific system defined by -p|-P and -s|-S

• -b | --no-back-fill : Disables attempting to "back fill" original data locations with new files, e.g. a new TV episode

• -B | --blacklist [file] : Blocks incoming connections from a list of IP addresses. See also -I | --ip-whitelist

• -c | --console-level [level] : Console logging level, default Info

• -C | --config [directory] : Sets the location of the ELS configuration directory. Use -C . for the current directory. Default is the user home directory in subdirectory .els/

• -d | --debug-level [level] : File logging level, default Info

• -D | --dry-run : Do everything except the actual action

• --dump-system : Print all JVM System.getProperties() values then exit

• -e | --export-text [file] : Export Publisher collection as text to file

• -E | --empty-directories : Report empty directories in the log

• -f | --log-file [file] : Log file, in append mode

• -F | --log-overwrite [file] : Log file, in overwrite mode

• -g | --listener-keep-going : For a Publisher the "keep going" option skips sending the quit command to a Subscriber when the backup operation is complete. For a Subscriber Listener it skips ending with a fault on most exceptions and ignores quit commands. To force a Subscriber to stop in this mode use the --listener-quit option

• -G | --listener-quit : Send the stop command to a remote Subscriber then exit. Similar to the -Q | --force-quit option

• -h | --hints [file] : Hint Tracker file to enable local Hints

• -H | --hint-server [file] : Hint Tracker file to execute ELS as a Hint Server listener operation. See Hints for details

• -i | --export-items [file] : Export Publisher collection as JSON to file

• -I | --ip-whitelist [file] : Filter incoming connections and only allow the list of whitelisted IP addresses. See also -B | --blacklist

• -j | --job [Job name] : Execute a previously-defined ELS Job. If the name contains whitespace enclose it in quotations. In this mode the job controls ELS actions

• -J | --override-hints-host : Use the Listen address:port for outgoing connection to a Hint Server instead of the Host. Used for LAN connections where Host is used over the Internet. A Hint Server listener only uses the Listen address. There is no address:port argument because there can be only one Hint Server

• -k | --keys [file] : ELS Hint keys file used to define which ELS instances (Libraries) are involved in tracking and executing Hints. Publishers opened as a Workstation do not track Hints

• -K | --keys-only [file] : ELS Hint keys file. Hints processing on Publisher only, skip the main back-up process. Useful for executing hints locally on the command line

• -l | --library [libraryname] : Individual Library to include from Collection, if not specified process all libraries. This option may be specified multiple times

• -L | --exclude [libraryname] : Individual Library to exclude fromm Collection, if not specified process all libraries. This option may be specified multiple times

• --logger : For the -j | --job action to execute the Job in the foreground with ELS operating in Logger mode to display the Job log. It is used internally when executing a Job in the foreground.

• -M|--email [email server] : To specify which Email Server to use for Mismatches, What's New and fault emails. If not defined the Default Email Server in Preferences is used for fault emails only, no Mismatches or What's New will be sent.

• -m | --mismatches [file] : Mismatches output list of differences during a back-up operation

• --marker "text" : To aid in identifying a specific running process. This option is ignored and intended to help with scripting.

• -n | --navigator : Display the ELS Navigator. Overrides other mode options.

• -N | --ignored : Log ignored files as defined in the Subscriber Library file during back-up operations. Examples: desktop.ini, Thumbs.db, .DS_Store

• -o | --overwrite : Overwrite any existing files instead of resuming a remote transfer. This option only applies to remote sessions.

• -O | --override-subscriber-host [address:port] : Override using the Host. If address:port is specified that is used, otherwise the Listen address:port defined in the Library file is used. If Listen is not defined Host is used.

• -p | --publisher-libraries [file] : Publisher JSON library file

• -P | --publisher-collection [file] : Publisher JSON collection file

• -q | --quit-status : Tell Hint Server to quit when operation complete

• -Q | --force-quit : Force the Hint Server to quit, then exit. Specifically intended to shut it down

• -r | --remote [P|L|M|S|T] : Type of emote session, see Communications How-To for details

• -s | --subscriber-libraries [file] : Subscriber JSON library file

• -S | --subscriber-collection [file] : Subscriber JSON collection file

• -t | --targets [file] : A back-up operation and optional Targets JSON file

• -T | --force-targets [file] : Forced targets for -r | --remote

• -u | --duplicates : Report duplicate Publisher items during back-up operation

• -v | --validate : Validate a Publisher library or collection file

• -V | --check-update : To check for an update from the command line. There is also a checkUpdate script in the bin/ directory. Useful for systems without a graphical desktop. See -Y | --install-update

• --version : Display version information then exit

• -w | --whatsnew [file] : What's New output file in summary

• -W | --whatsnew-all [file] : What's New output file with all new items

• -x | --cross-check : Cross-check ALL libraries for duplicate items instead of just within that item's library. Applies to back-up actions

• -y | --preserve-dates : To retrain original file dates

• -Y | --install-update : To install an update from the command line. There is also an installUpdate script in the bin/ directory. Useful for systems without a graphical desktop. Installs the latest update regardless of whether the versions match. See -V | --check-update

• -z | --decimnal-scale : To format numeric (B, KB, MB, GB, TB) values with a 1000 decimal scale instead of a 1024 binary scale

Log Levels

Log Levels: ALL, TRACE, DEBUG, INFO, WARN, ERROR, FATAL, and OFF. The debug level controls the log file. The console level controls what is seen on the screen.

Windows Shortcut Length Limit

ELS has many options. Windows has a 260-character limit for shortcuts, including those created by the Generate buttons in Navigator. There are a couple of ways to get around this.

1. Create a batch file to execute ELS.
2. Use a Navigator Job:
   1. Use Tools, Operations to define a Tool for your operation and it's parameters.
   2. Use Jobs, Manage to define a Job with a Task that is your Tool.
   3. Generate a command line or create a shortcut to the Job using Jobs, Manage, Generate/Run.

Multiple actions

Different actions can be performed during one execution, i.e. actions may be combined. The order of processing of the actions is:

1. Execute local Hints, if enabled, single operation then stops
2. Text export with -e | --export-text
3. Item export with -i | --export-items
4. Duplicates check with -u | --duplicates
5. Send any Hints for Subscriber and execute, if enabled
6. Rescan the collections if any Hints were processed
7. Finally a back-up operation if all necessary arguments are provided.

Linux Caution

On Linux-based systems ELS should be executed as the user that owns the data to ensure the ownership and permissions of copied content have the appropriate attributes.

In addition, it is not possible to login as 'root' then sudo ELS in -r M (manual) or -r T (terminal) modes because the program will not have the necessary permissions to open the display.