From 1531177d8dd2e284520881295fecc582d35119bf Mon Sep 17 00:00:00 2001 From: derrod Date: Sat, 30 May 2020 22:56:20 +0200 Subject: [PATCH] [cli/README] Various changes to help texts --- README.md | 56 +++++++++++++++++++++++----------------------- legendary/cli.py | 58 +++++++++++++++++++++++++----------------------- 2 files changed, 58 insertions(+), 56 deletions(-) diff --git a/README.md b/README.md index 7f56acf..1dc20ba 100644 --- a/README.md +++ b/README.md @@ -169,10 +169,10 @@ usage: legendary auth [-h] [--import] [--code ] [--delete] optional arguments: -h, --help show this help message and exit - --import Import EGS authentication data + --import Import Epic Games Launcher authentication data (logs out of EGL) --code - Use specified exchange code instead of interactive authentication. - --delete Remove existing authentication data + Use specified exchange code instead of interactive authentication + --delete Remove existing authentication (log out) Command: install @@ -186,28 +186,28 @@ positional arguments: optional arguments: -h, --help show this help message and exit --base-path Path for game installations (defaults to ~/legendary) - --game-folder Folder for game installation (defaults to folder in metadata) + --game-folder Folder for game installation (defaults to folder specified in metadata) --max-shared-memory Maximum amount of shared memory to use (in MiB), default: 1 GiB - --max-workers Maximum amount of download workers, default: 2 * logical CPU + --max-workers Maximum amount of download workers, default: min(2 * CPUs, 16) --manifest Manifest URL or path to use instead of the CDN one (e.g. for downgrading) --old-manifest Manifest URL or path to use as the old one (e.g. for testing patching) --base-url Base URL to download from (e.g. to test or switch to a different CDNs) - --force Ignore existing files (overwrite) - --disable-patching Do not attempt to patch existing installations (download entire changed file) + --force Download all files / ignore existing (overwrite) + --disable-patching Do not attempt to patch existing installation (download entire changed files) --download-only, --no-install - Do not mark game as intalled and do not run prereq installers after download - --update-only Abort if game is not already installed (for automation) + Do not intall app and do not run prerequisite installers after download + --update-only Only update, do not do anything if specified app is not installed --dlm-debug Set download manager and worker processes' loglevel to debug --platform - Platform override for download (disables install) + Platform override for download (also sets --no-install) --prefix Only fetch files whose path starts with (case insensitive) --exclude Exclude files starting with (case insensitive) - --install-tag Only download files with the specified install tag (testing) - --enable-reordering Enable reordering to attempt to optimize RAM usage during download + --install-tag Only download files with the specified install tag + --enable-reordering Enable reordering optimization to reduce RAM requirements during download (may have adverse results for some titles) --dl-timeout Connection timeout for downloader (default: 10 seconds) - --save-path Set save game path during install. - --repair Repair already installed game by downloading corrupted/missing files + --save-path Set save game path to be used for sync-saves + --repair Repair installed game by checking and redownloading corrupted/missing files Command: uninstall @@ -236,13 +236,13 @@ optional arguments: Override username used when launching the game (only works with some titles) --dry-run Print the command line that would have been used to launch the game and exit --language - Override language for game launch (defaults to system settings) + Override language for game launch (defaults to system locale) --wrapper Wrapper command to launch game with - --wine Override WINE binary being used to launch the game + --wine Set WINE binary to use to launch the app --wine-prefix - Override WINE prefix used. - --no-wine Do not use WINE (e.g. if a wrapper is being used) + Set WINE prefix to use + --no-wine Do not run game with WINE (e.g. if a wrapper is used) Command: list-games @@ -251,8 +251,8 @@ usage: legendary list-games [-h] [--platform ] [--include-ue] [--csv] optional arguments: -h, --help show this help message and exit --platform - Override platform that games are shown for - --include-ue Also include Unreal Engine content in list + Override platform that games are shown for (e.g. Win32/Mac) + --include-ue Also include Unreal Engine content (Engine/Marketplace) in list --csv List games in CSV format --tsv List games in TSV format @@ -262,7 +262,7 @@ usage: legendary list-installed [-h] [--check-updates] [--csv] [--tsv] optional arguments: -h, --help show this help message and exit - --check-updates Check for updates when listing installed games + --check-updates Check for updates for installed games --csv List games in CSV format --tsv List games in TSV format @@ -281,7 +281,7 @@ optional arguments: --manifest Manifest URL or path to use instead of the CDN one --csv Output in CSV format --tsv Output in TSV format - --hashlist Output file hash list in hashcheck/sha1sum compatible format + --hashlist Output file hash list in hashcheck/sha1sum -c compatible format --install-tag Show only files with specified install tag @@ -317,8 +317,8 @@ optional arguments: --skip-download Only upload new saves from cloud, don't download --force-upload Force upload even if local saves are older --force-download Force download even if local saves are newer - --save-path Override savegame path (only if app name is specified) - --disable-filters Disable save game file filtering (in case it breaks) + --save-path Override savegame path (requires single app name to be specified) + --disable-filters Disable save game file filtering Command: verify-game @@ -341,7 +341,7 @@ positional arguments: optional arguments: -h, --help show this help message and exit - --disable-check Disables checks of specified game install. + --disable-check Disables completeness check of the to-be-imported game installation (useful if the imported game is a much older version or missing files) Command: egl-sync @@ -353,11 +353,11 @@ optional arguments: Path to the Epic Games Launcher's Manifests folder, should point to /ProgramData/Epic/EpicGamesLauncher/Data/Manifests --egl-wine-prefix EGL_WINE_PREFIX Path to the WINE prefix the Epic Games Launcher is installed in - --enable-sync Enable automatic EGL<->Legendary sync - --one-shot Sync once, do not ask to setup automatic sync. + --enable-sync Enable automatic EGL <-> Legendary sync + --one-shot Sync once, do not ask to setup automatic sync --import-only Only import games from EGL (no export) --export-only Only export games to EGL (no import) - --unlink Disable sync and remove EGS flags. + --unlink Disable sync and remove EGL metadata from installed games ```` diff --git a/legendary/cli.py b/legendary/cli.py index 9de0fb5..e689ea2 100644 --- a/legendary/cli.py +++ b/legendary/cli.py @@ -901,20 +901,20 @@ def main(): # importing only works on Windows right now if os.name == 'nt': auth_parser.add_argument('--import', dest='import_egs_auth', action='store_true', - help='Import EGS authentication data') + help='Import Epic Games Launcher authentication data (logs out of EGL)') auth_parser.add_argument('--code', dest='auth_code', action='store', metavar='', - help='Use specified exchange code instead of interactive authentication.') + help='Use specified exchange code instead of interactive authentication') auth_parser.add_argument('--delete', dest='auth_delete', action='store_true', - help='Remove existing authentication data') + help='Remove existing authentication (log out)') install_parser.add_argument('--base-path', dest='base_path', action='store', metavar='', help='Path for game installations (defaults to ~/legendary)') install_parser.add_argument('--game-folder', dest='game_folder', action='store', metavar='', - help='Folder for game installation (defaults to folder in metadata)') + help='Folder for game installation (defaults to folder specified in metadata)') install_parser.add_argument('--max-shared-memory', dest='shared_memory', action='store', metavar='', type=int, help='Maximum amount of shared memory to use (in MiB), default: 1 GiB') install_parser.add_argument('--max-workers', dest='max_workers', action='store', metavar='', - type=int, help='Maximum amount of download workers, default: 2 * logical CPU') + type=int, help='Maximum amount of download workers, default: min(2 * CPUs, 16)') install_parser.add_argument('--manifest', dest='override_manifest', action='store', metavar='', help='Manifest URL or path to use instead of the CDN one (e.g. for downgrading)') install_parser.add_argument('--old-manifest', dest='override_old_manifest', action='store', metavar='', @@ -922,31 +922,32 @@ def main(): install_parser.add_argument('--base-url', dest='override_base_url', action='store', metavar='', help='Base URL to download from (e.g. to test or switch to a different CDNs)') install_parser.add_argument('--force', dest='force', action='store_true', - help='Ignore existing files (overwrite)') + help='Download all files / ignore existing (overwrite)') install_parser.add_argument('--disable-patching', dest='disable_patching', action='store_true', - help='Do not attempt to patch existing installations (download entire changed file)') + help='Do not attempt to patch existing installation (download entire changed files)') install_parser.add_argument('--download-only', '--no-install', dest='no_install', action='store_true', - help='Do not mark game as intalled and do not run prereq installers after download') + help='Do not intall app and do not run prerequisite installers after download') install_parser.add_argument('--update-only', dest='update_only', action='store_true', - help='Abort if game is not already installed (for automation)') + help='Only update, do not do anything if specified app is not installed') install_parser.add_argument('--dlm-debug', dest='dlm_debug', action='store_true', help='Set download manager and worker processes\' loglevel to debug') install_parser.add_argument('--platform', dest='platform_override', action='store', metavar='', - type=str, help='Platform override for download (disables install)') + type=str, help='Platform override for download (also sets --no-install)') install_parser.add_argument('--prefix', dest='file_prefix', action='append', metavar='', help='Only fetch files whose path starts with (case insensitive)') install_parser.add_argument('--exclude', dest='file_exclude_prefix', action='append', metavar='', type=str, help='Exclude files starting with (case insensitive)') install_parser.add_argument('--install-tag', dest='install_tag', action='append', metavar='', - type=str, help='Only download files with the specified install tag (testing)') + type=str, help='Only download files with the specified install tag') install_parser.add_argument('--enable-reordering', dest='order_opt', action='store_true', - help='Enable reordering to attempt to optimize RAM usage during download') + help='Enable reordering optimization to reduce RAM requirements ' + 'during download (may have adverse results for some titles)') install_parser.add_argument('--dl-timeout', dest='dl_timeout', action='store', metavar='', type=int, help='Connection timeout for downloader (default: 10 seconds)') install_parser.add_argument('--save-path', dest='save_path', action='store', metavar='', - help='Set save game path during install.') + help='Set save game path to be used for sync-saves') install_parser.add_argument('--repair', dest='repair_mode', action='store_true', - help='Repair already installed game by downloading corrupted/missing files') + help='Repair installed game by checking and redownloading corrupted/missing files') launch_parser.add_argument('--offline', dest='offline', action='store_true', default=False, help='Skip login and launch game without online authentication') @@ -957,7 +958,7 @@ def main(): launch_parser.add_argument('--dry-run', dest='dry_run', action='store_true', help='Print the command line that would have been used to launch the game and exit') launch_parser.add_argument('--language', dest='language', action='store', metavar='', - help='Override language for game launch (defaults to system settings)') + help='Override language for game launch (defaults to system locale)') launch_parser.add_argument('--wrapper', dest='wrapper', action='store', metavar='', default=os.environ.get('LGDRY_WRAPPER', None), help='Wrapper command to launch game with') @@ -965,13 +966,13 @@ def main(): if os.name != 'nt': launch_parser.add_argument('--wine', dest='wine_bin', action='store', metavar='', default=os.environ.get('LGDRY_WINE_BINARY', None), - help='Override WINE binary being used to launch the game') + help='Set WINE binary to use to launch the app') launch_parser.add_argument('--wine-prefix', dest='wine_pfx', action='store', metavar='', default=os.environ.get('LGDRY_WINE_PREFIX', None), - help='Override WINE prefix used.') + help='Set WINE prefix to use') launch_parser.add_argument('--no-wine', dest='no_wine', action='store_true', default=strtobool(os.environ.get('LGDRY_NO_WINE', 'False')), - help='Do not use WINE (e.g. if a wrapper is being used)') + help='Do not run game with WINE (e.g. if a wrapper is used)') else: # hidden arguments to not break this on Windows launch_parser.add_argument('--wine', help=argparse.SUPPRESS, dest='wine_bin') @@ -980,14 +981,14 @@ def main(): action='store_true', default=True) list_parser.add_argument('--platform', dest='platform_override', action='store', metavar='', - type=str, help='Override platform that games are shown for') + type=str, help='Override platform that games are shown for (e.g. Win32/Mac)') list_parser.add_argument('--include-ue', dest='include_ue', action='store_true', - help='Also include Unreal Engine content in list') + help='Also include Unreal Engine content (Engine/Marketplace) in list') list_parser.add_argument('--csv', dest='csv', action='store_true', help='List games in CSV format') list_parser.add_argument('--tsv', dest='tsv', action='store_true', help='List games in TSV format') list_installed_parser.add_argument('--check-updates', dest='check_updates', action='store_true', - help='Check for updates when listing installed games') + help='Check for updates for installed games') list_installed_parser.add_argument('--csv', dest='csv', action='store_true', help='List games in CSV format') list_installed_parser.add_argument('--tsv', dest='tsv', action='store_true', @@ -1002,7 +1003,7 @@ def main(): list_files_parser.add_argument('--csv', dest='csv', action='store_true', help='Output in CSV format') list_files_parser.add_argument('--tsv', dest='tsv', action='store_true', help='Output in TSV format') list_files_parser.add_argument('--hashlist', dest='hashlist', action='store_true', - help='Output file hash list in hashcheck/sha1sum compatible format') + help='Output file hash list in hashcheck/sha1sum -c compatible format') list_files_parser.add_argument('--install-tag', dest='install_tag', action='store', metavar='', type=str, help='Show only files with specified install tag') @@ -1015,12 +1016,13 @@ def main(): sync_saves_parser.add_argument('--force-download', dest='force_download', action='store_true', help='Force download even if local saves are newer') sync_saves_parser.add_argument('--save-path', dest='save_path', action='store', metavar='', - help='Override savegame path (only if app name is specified)') + help='Override savegame path (requires single app name to be specified)') sync_saves_parser.add_argument('--disable-filters', dest='disable_filters', action='store_true', - help='Disable save game file filtering (in case it breaks)') + help='Disable save game file filtering') import_parser.add_argument('--disable-check', dest='disable_check', action='store_true', - help='Disables checks of specified game install.') + help='Disables completeness check of the to-be-imported game installation ' + '(useful if the imported game is a much older version or missing files)') egl_sync_parser.add_argument('--egl-manifest-path', dest='egl_manifest_path', action='store', help='Path to the Epic Games Launcher\'s Manifests folder, should ' @@ -1028,15 +1030,15 @@ def main(): egl_sync_parser.add_argument('--egl-wine-prefix', dest='egl_wine_prefix', action='store', help='Path to the WINE prefix the Epic Games Launcher is installed in') egl_sync_parser.add_argument('--enable-sync', dest='enable_sync', action='store_true', - help='Enable automatic EGL<->Legendary sync') + help='Enable automatic EGL <-> Legendary sync') egl_sync_parser.add_argument('--one-shot', dest='one_shot', action='store_true', - help='Sync once, do not ask to setup automatic sync.') + help='Sync once, do not ask to setup automatic sync') egl_sync_parser.add_argument('--import-only', dest='import_only', action='store_true', help='Only import games from EGL (no export)') egl_sync_parser.add_argument('--export-only', dest='export_only', action='store_true', help='Only export games to EGL (no import)') egl_sync_parser.add_argument('--unlink', dest='unlink', action='store_true', - help='Disable sync and remove EGS flags.') + help='Disable sync and remove EGL metadata from installed games') args, extra = parser.parse_known_args()