mirror of
https://github.com/QuasarApp/CQtDeployer.git
synced 2025-05-09 16:09:37 +00:00
ref #520 "fix options description"
This commit is contained in:
parent
69e35ba344
commit
bb1423c4ab
@ -225,7 +225,14 @@ void DeployCore::help() {
|
||||
},
|
||||
{
|
||||
"Part 2 Deploy options", {
|
||||
{"-bin [list, params]", "Deployable file or folder. For example -bin ~/my/project/bin/,~/my/project/bin.exe"},
|
||||
{"-bin [list, params]", "Files to deploy or folders that contain files to deploy."
|
||||
" For example -bin ~/my/project/bin/,~/my/project/bin.exe,~/my/project/runtimeLinking/lib.dll."
|
||||
" For files: These files will be unconditional copied to the destination directory,"
|
||||
" regardless of their format or suffix."
|
||||
" For folders:"
|
||||
" CQtDeployer will enter these folders and non-recursively copy all deployable files to the destination directory."
|
||||
" Then, CQtDeployer will be extract all dependencies of the copied files."
|
||||
" The CQtDeployer will be search dependencies in a system environment and in libDir paths."},
|
||||
{"-confFile [params]", "The path to the json file with all deployment configurations. Using this file,"
|
||||
" you can add the necessary options, thereby simplifying the command invocation in the console."
|
||||
" However, the parameters in Kansol have a higher priority than in the file."
|
||||
@ -236,8 +243,9 @@ void DeployCore::help() {
|
||||
{"-ignoreEnv [list,params]", "The list of the environment to ignore. For example -ignoreEnv /bad/dir,/my/bad/Dir"},
|
||||
{"-libDir [list,params]", "Sets additional paths for extra libs of an app. For example -libDir ~/myLib,~/newLibs"},
|
||||
{"-extraLibs [list,params]", "Sets the mask of the library name for forced copying."
|
||||
" Example: '-extraLibs mySql' - forces to copy all libraries whose names contain mySql to the project folder."
|
||||
" This option is case sensitive."},
|
||||
" Example: \"-extraLib mySql\" - forces to copy all libraries whose names contain mySql to the project folder."
|
||||
" This option is case-insensitive on Windows and case-sensitive on other platforms."
|
||||
" This option will only search libraries in system environments similar to **deploySystem**.",
|
||||
{"-customScript [scriptCode]", "Insert extra code inTo All run script."},
|
||||
{"-recursiveDepth [params]", "Sets the Depth of recursive search of libs and depth for ignoreEnv option (default 0)"},
|
||||
{"-targetDir [params]", "Sets target directory(by default it is the path to the first deployable file)"},
|
||||
|
||||
@ -16,6 +16,14 @@ cqtdeployer -option1 value1 -option2 list, of, values flag1 flag2 flag3
|
||||
* **-libOut [package;path,path]** - parameter with support for selecting the package for which the flag value is set. As a separator, use ';'. Please note that the rule described above is used to enumerate parameter values. The last parameter does not have a package value, this means that this value will be set for all non-configured packages by default.
|
||||
* **clear** - boolean option
|
||||
|
||||
## Definitions in description
|
||||
**System environment** - is pathes of the sstem libraryes.
|
||||
Windows: C:\Windows\System32 and C:\Windows\SysWOW64. And any another pathes difined in the PATH variable.
|
||||
Linux: /usr/lib and /lib. And any another pathes defined in the LD_LIBRARY_PATH or PATH variables.
|
||||
|
||||
**Deployable files** - is all file that will be copy in to targer dirictory. (libraries, resources)
|
||||
**Targets** - is all files marked by bin option.
|
||||
|
||||
## Options:
|
||||
|
||||
### Boolean options
|
||||
@ -57,7 +65,7 @@ cqtdeployer -option1 value1 -option2 list, of, values flag1 flag2 flag3
|
||||
|
||||
| Option | Descriptiion |
|
||||
|-----------------------------|-----------------------------------------------------------|
|
||||
| -bin [list,params] | Files to deploy or folders that contain files to deploy. For example -bin ~/my/project/bin/,~/my/project/bin.exe,~/my/project/runtimeLinking/lib.dll. For files: These files will be unconditional copied to the destination directory, regardless of their format or suffix. For folders: CQtDeployer will enter these folders and non-recursively copy all deployable files to the destination directory. Then, the dependencies of all the deployable files in these files and found from these folders will be searched in system environments and the path specified in **libDir**, and copied to the destination directory, too. |
|
||||
| -bin [list,params] | Files to deploy or folders that contain files to deploy. For example -bin ~/my/project/bin/,~/my/project/bin.exe,~/my/project/runtimeLinking/lib.dll. For files: These files will be unconditional copied to the destination directory, regardless of their format or suffix. For folders: CQtDeployer will enter these folders and non-recursively copy all deployable files to the destination directory. Then, CQtDeployer will be extract all dependencies of the copied files. The CQtDeployer will be search dependencies in a system environment and in libDir paths. |
|
||||
| -confFile [params] | The path to the json file with all deployment configurations.|
|
||||
| | Using this file, you can add the necessary options, |
|
||||
| | thereby simplifying in the command invocation the console. |
|
||||
@ -73,8 +81,7 @@ cqtdeployer -option1 value1 -option2 list, of, values flag1 flag2 flag3
|
||||
| -libDir [list,params] | Sets additional paths for extra libs of an app. |
|
||||
| | For example -libDir ~/myLib,~/newLibs |
|
||||
| -extraLibs [list,params] | Sets the mask of the library name for forced copying. |
|
||||
| | Example: "-extraLib mySql" - forces to copy all libraries whose |
|
||||
| |names contain mySql to the project folder. This option is case-insensitive on Windows and case-sensitive on other platforms. This option will only search libraries in system environments similar to **deploySystem**.|
|
||||
| | Example: "-extraLib mySql" - forces to copy all libraries whose names contain mySql to the project folder. This option is case-insensitive on Windows and case-sensitive on other platforms. This option will only search libraries in system environments similar to **deploySystem**.|
|
||||
| -customScript [scriptCode]| Insert extra code inTo All run script. |
|
||||
| -extraPlugin [list,params]| Sets an additional path to extraPlugin of an app |
|
||||
| -recursiveDepth [params] | Sets the Depth of recursive search of libs and ignoreEnv (default 0) |
|
||||
|
||||
@ -18,6 +18,14 @@ cqtdeployer -option1 value1 -option2 list,of,values flag1 flag2 flag3
|
||||
* **-libOut [package;path,path]** - параметр c поддержкой выбора пакета для которого бутет установленно значение флага. В качестве разделителя используется ';'. Обратитте внимание что для перечисления значений параметра используется правило описанное выше. Последний параметр не имеет значение пакета, это значит что это значение будет установленно для всех не настроенных пакетов по умолчанию.
|
||||
* **clear** - флаг
|
||||
|
||||
## Определения в описании
|
||||
**Системное окружение** - пути к системным библиотекам.
|
||||
Windows: C:\Windows\System32 и C:\Windows\SysWOW64. И любые другие пути, указанные в переменной PATH.
|
||||
Linux: /usr/lib и /lib. И любые другие пути, определенные в переменных LD_LIBRARY_PATH или PATH.
|
||||
|
||||
**Развертываемые файлы** - это все файлы, которые будут скопированы в каталог назначения. (библиотеки, ресурсы)
|
||||
**Цели** - это все файлы, отмеченные опцией bin.
|
||||
|
||||
## Параметры:
|
||||
|
||||
### Флаги
|
||||
@ -58,7 +66,7 @@ cqtdeployer -option1 value1 -option2 list,of,values flag1 flag2 flag3
|
||||
|
||||
| Option | Descriptiion |
|
||||
|-----------------------------|-----------------------------------------------------------|
|
||||
| -bin [list,params] | Развертываемый файл или папка. пример -bin ~/my/project/bin/,~/my/project/bin.exe. Опция bin также может работать с файлами любого формата. Все, что будет указано в качестве аргументов этой опции, будет скопировано в папку DestributionKit/bin и будет расположено рядом с исполняемыми файлами. |
|
||||
| -bin [list,params] | Развертываемый файл или папка. пример -bin ~/my/project/bin/,~/my/project/bin.exe. Для файлов: эти файлы будут безоговорочно скопированы в целевой каталог, независимо от их формата или суффикса. Для папок: CQtDeployer войдет в эти папки и нерекурсивно скопирует все развертываемые файлы в целевой каталог. Затем CQtDeployer извлечет все зависимости скопированных файлов. CQtDeployer будет искать зависимости в системной среде и в путях libDir. |
|
||||
| -confFile [params] | Путь к файлу json со всеми конфигурациями развертывания. С помощью этого файла можно добавить нужные опции, тем самым упрастить вызов комманды в консоле. Однако пораметры в кансоле имеют больший приоритет чем в файле. Для получения дополнительной информации об этом флаге см. [Вики](DeployConfigFile) |
|
||||
| -qmlDir [params] | Папка qml. пример -qmlDir ~/my/project/qml |
|
||||
| -qmake [params] | Путь к qmake. пример |
|
||||
@ -69,7 +77,7 @@ cqtdeployer -option1 value1 -option2 list,of,values flag1 flag2 flag3
|
||||
| | Пример -ignoreEnv /bad/dir,/my/bad/Dir |
|
||||
| -libDir [list,params] | Устанавливает дополнительные пути к библиотекам |
|
||||
| | Пример -libDir ~/myLib,~/newLibs |
|
||||
| -extraLibs [list,params] | Устанавливает маску имени библиотеки, для принудительного копирования, Пример "-extraLib mySql" - заставит скопировать в папку с проектом все библиотеки чии имена содержат mySql. Данная опция чуствительна к регистру. Данная опция не будет копировать библиотеки чии именна не будут упомянуты в списке зависимостей цклей (Пример: плагины или библиотеки загруженные c помощью функции **dlopen** или **LoadLibrary**).|
|
||||
| -extraLibs [list,params] | Пример: «-extraLib mySql» - заставляет скопировать все библиотеки, имена которых содержат mySql, в папку проекта. Этот параметр не чувствителен к регистру в Windows и чувствителен к регистру на других платформах. Эта опция будет искать библиотеки только в системных средах, подобных **deploySystem**. |
|
||||
| -customScript [scriptCode] | Установит дополнительный код в скрипты запуска. |
|
||||
| -extraPlugin [list,params] | Устанавливает дополнительный путь для extraPlugin приложения|
|
||||
| -recursiveDepth [params] | Устанавливает глубину поиска библиотек и глубину игнорирования окружения для ignoreEnv (по умолчанию 0) |
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user