Online Help
Command line
How to use prompt-like Console, command line options and e2se-cli command line interface.
Console
Console is a prompt-like util with step-by-step, question and answer, textual approach editing.
Note: Console is a beta util.
To open the Console, click Console.
From main menu, click menu Tools > Console
From bottom toolbar, click "Console"
From bottom toolbar, click on "Tools" > Console
Command
To execute command, type the command and press Enter key.
eg. for help, type help and press Enter key
eg. for usage hints, type help [COMMAND] and press Enter key, eg. help edit
Edit
When using add and edit commands, will be prompted questions and answers to fill the data item.
eg. type add transponder and press Enter key
To interrupt edit, press Esc key
Navigation
When using listing commands, will be prompted paginated list of items.
eg. type list services and press Enter key
eg. 15 item per page, type list services 15 and press Enter
For next page, press Page Down key
For previous page, press Page Up key
To interrupt listing, press Q or Esc key
Tab control
To control current tab, type tab and press Enter key.
eg. to reload current tab views, type tab reload and press Enter key
eg. to clear current tab views, type tab clear and press Enter key
Console is dockable on current tab and its child tabs.
To personalize console font, go to "Settings" > Advanced > [confirm].
In the editable table, double-click on the cell to edit the preference value.
Change the application.consoleFont preference, for example 13px Consolas.
Save your settings by pressing "Save" button.
In order to display the text properly, it is recommended to use a fixed-width font, monospaced font.
Note: This preference cannot be applied in real-time, re-open the console to try the font preference.
For more information about "font" syntax (Qt Style Sheets), please refer to the Qt toolkit documentation at: https://doc.qt.io/qt-6/stylesheet-reference.html#font
Note: Console available since software version 2.0
Command line options
The software runs from the command line also, optionally with a file name or option.
Open a terminal and launch the software – from its current location, eg. cd e2-sat-editor-directory – followed by a directory [FILE] path or [OPTION].
Windows PowerShell .\e2-sat-editor.exe [FILE] [OPTION]
Windows CMD e2-sat-editor.exe [FILE] [OPTION]
macOS ./e2\ SAT\ Editor.app/Contents/MacOS/e2\ SAT\ Editor [FILE] [OPTION]
Linux (AppImage) ./e2-sat-editor-VERSION-x86_64-linux.AppImage [FILE] [OPTION]
Linux (Snap) snap run e2-sat-editor [FILE] [OPTION]
Linux (Flatpak) flatpak run io.github.ctlcltd.e2se [FILE] [OPTION]
Other shell ./e2-sat-editor [FILE] [OPTION]
Open a directory file
To open a directory path from command line.
[FILE] eg. e2-sat-editor [FILE]
Show software version
To show the software version from command line.
--version eg. e2-sat-editor --version
Debugging option
To turn on software logs and show debug informations.
--debug eg. e2-sat-editor --debug
Another way to show debug info using enviroment variable DEBUG.
Windows PowerShell eg. $env:QT_WIN_DEBUG_CONSOLE="new"; $env:DEBUG=1; .\e2-sat-editor.exe [FILE] [OPTION]
macOS eg. DEBUG=1 ./e2\ SAT\ Editor.app/Contents/MacOS/e2\ SAT\ Editor [FILE] [OPTION]
Linux (AppImage) eg. DEBUG=1 ./e2-sat-editor-VERSION-x86_64-linux.AppImage [FILE] [OPTION]
Other shell eg. DEBUG=1 ./e2-sat-editor [FILE] [OPTION]
Command line interface [e2se-cli]
Command line interface is provided by e2se-cli application binary.
Interactive shell aims to have almost the same features of the software GUI counterpart.
Note: e2se-cli is a beta util.
Open a terminal and launch the software – from its current location, eg. cd e2-sat-editor-directory/cli – optionally followed by [OPTION].
Windows PowerShell .\e2se-cli.exe [OPTION]
Windows CMD e2se-cli.exe [OPTION]
macOS ./e2se-cli [OPTION]
Linux (AppImage) ./e2se-cli-VERSION-x86_64-linux.AppImage [OPTION]
Other shell ./e2se-cli [OPTION]
Typical usage
To open interactive shell.
Open a terminal and launch the software: e2se-cli
Command [Interactive shell]
To execute command, type the command and press Enter key.
eg. for help, type help and press Enter key
eg. to open directory path, type read [FILE] and press Enter key
eg. to save directory path, type write [FILE] and press Enter key
Edit [Interactive shell]
When using add and edit commands, will be prompted questions and answers to fill the data item.
eg. type add transponder and press Enter key
Navigation [Interactive shell]
When using listing commands, will be prompted paginated list of items.
eg. type list services and press Enter key
eg. 15 item per page, type list services 15 and press Enter key
For next page, press Page Down key
For previous page, press Page Up key
To interrupt listing, press Q key
Show help
To show usage help.
-h --help eg. e2se-cli --help
From interactive shell, for help, type help and press Enter key
From interactive shell, for usage hints, type help [COMMAND] and press Enter key, eg. help edit
Show software version
To show the software version from command line.
-v --version eg. e2se-cli --version
From interactive shell, type version