From 6ab29597e23da407965975af783c910119e0c9b6 Mon Sep 17 00:00:00 2001 From: Vladislav Yarmak Date: Thu, 24 Oct 2019 13:07:13 +0300 Subject: [PATCH] win: ap: update docs --- win/tools/autopatch/README.md | 43 ++++++++++++++++++++++------------- 1 file changed, 27 insertions(+), 16 deletions(-) diff --git a/win/tools/autopatch/README.md b/win/tools/autopatch/README.md index cb21f52..d982b9a 100644 --- a/win/tools/autopatch/README.md +++ b/win/tools/autopatch/README.md @@ -3,7 +3,11 @@ autopatch This tool is intended for internal usage. -This script accepts path to Nvidia Drivers installer, makes .1337 patch and saves it in appropriate location in your working copy of this repo. All you have to do then is to test patch, stage it for commit and push it. Optionally you can just save patch to stdout. +This script accepts path to Nvidia Drivers installer file(s), makes .1337 patch and saves it in appropriate location in your working copy of this repo. All you have to do then is to test patch, stage it for commit and push it. Optionally you can just save patch to stdout. + +If you have already extracted binary files, you can supply them directly to autopatch running in direct mode `-D` option. In this case number of input files must match count of replacement patterns. + +Note: when command line options with multiple possible arguments supplied (like patterns or targets), you must separate them from positional arguments (input files) with a double dash (`--`). Example: `./autopatch.py -P nvcuvid32.1337 nvcuvid64.1337 -T nvcuvid32.dll nvcuvid64.dll -- setup1.exe setup2.exe`. ## Requirements @@ -13,9 +17,10 @@ This script accepts path to Nvidia Drivers installer, makes .1337 patch and save ## Synopsys ``` -$ ./autopatch.py --help -usage: autopatch.py [-h] [-7 SEVENZIP] [-T TARGET] [-N TARGET_NAME] - [-S SEARCH] [-R REPLACEMENT] [-o] +usage: autopatch.py [-h] [-7 SEVENZIP] [-T TARGET [TARGET ...]] + [-N TARGET_NAME [TARGET_NAME ...]] + [-P PATCH_NAME [PATCH_NAME ...]] [-S SEARCH [SEARCH ...]] + [-R REPLACEMENT [REPLACEMENT ...]] [-o] [-D] installer_file [installer_file ...] Generates .1337 patch for Nvidia drivers for Windows @@ -27,17 +32,23 @@ optional arguments: -h, --help show this help message and exit -7 SEVENZIP, --7zip SEVENZIP location of 7-zip `7z` executable (default: 7z) - -T TARGET, --target TARGET - target location in archive (default: - Display.Driver/nvcuvid64.dl_) - -N TARGET_NAME, --target-name TARGET_NAME - name of installed target file. Used for patch header - (default: nvcuvid.dll) - -S SEARCH, --search SEARCH - representation of search pattern binary string - (default: FF908000000084C07408) - -R REPLACEMENT, --replacement REPLACEMENT - representation of replacement binary string (default: - FF908000000084C09090) + -T TARGET [TARGET ...], --target TARGET [TARGET ...] + target location(s) in archive (default: + ['Display.Driver/nvcuvid64.dl_', + 'Display.Driver/nvcuvid32.dl_']) + -N TARGET_NAME [TARGET_NAME ...], --target-name TARGET_NAME [TARGET_NAME ...] + name(s) of installed target file. Used for patch + header (default: ['nvcuvid.dll', 'nvcuvid.dll']) + -P PATCH_NAME [PATCH_NAME ...], --patch-name PATCH_NAME [PATCH_NAME ...] + relative filename(s) of generated patch(es) (default: + ['nvcuvid64.1337', 'nvcuvid32.1337']) + -S SEARCH [SEARCH ...], --search SEARCH [SEARCH ...] + representation of search pattern(s) binary string + (default: ['FF909800000084C075', '8B404CFFD084C075']) + -R REPLACEMENT [REPLACEMENT ...], --replacement REPLACEMENT [REPLACEMENT ...] + representation of replacement(s) binary string + (default: ['FF90980000000C0175', '8B404CFFD00C0175']) -o, --stdout output into stdout (default: False) + -D, --direct supply patched library directly instead of installer + file. Implies --stdout option. (default: False) ```