Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Обновление документации (#10) #11

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Обновление документации (#10) #11

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
bf5ee8d
Merge pull request #37 from vanessa-opensource/main
alex-bob-lip Jan 5, 2025
36b7b30
Обновление документации (#10 vanessa-opensource/ibmcmdrunner)
alex-bob-lip Jan 5, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion Readme.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@
КонфигФайл.СоздатьКонфигурационныйФайл("c:\tmp\my-config.yml");
```

## [Программный интерфейс](https://github.com/alex-bob-lip/ibcmdrunner/tree/main/doc/doc.md)
## [Программный интерфейс](https://github.com/vanessa-opensource/ibcmdrunner/tree/main/doc/doc.md)

## Лицензия

Expand Down
81 changes: 80 additions & 1 deletion doc/doc.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -186,9 +186,68 @@
<td>Возвращает код возврата последней выполненной команды.
</td>
</tr>
<tr>
<td><a href="Класс/УправлениеИБ/ОписанияРасширений.md">ОписанияРасширений</a></td>
<td>Возвращает список расширений информационной базы в виде массива соответствий.
</td>
</tr>
</table>

## 2. Класс: КонфигурационныйФайлАС
## 2. Класс: УправлениеАС
<table bordercolor="#c0c0c0" cellpadding="3" cellspacing="0" width="100%" border="1">
<tr>
<th height="16" width="25%"><b>Метод</b></td>
<th height="16" width="75%"><b>Описание</b></td>
</tr><tr>
<td><a href="Класс/УправлениеАС/Версия.md">Версия</a></td>
<td>Текущая версия утилиты ibsrv</td>
</tr>
<tr>
<td><a href="Класс/УправлениеАС/УстановитьВерсиюПлатформы.md">УстановитьВерсиюПлатформы</a></td>
<td>Устанавливает версию платформы, которая будет использована для запуска утилиты ibsrv</td>
</tr>
<tr>
<td><a href="Класс/УправлениеАС/УстановитьКаталогДанных.md">УстановитьКаталогДанных</a></td>
<td>Устанавливает путь к каталогу данных автономного сервера.</td>
</tr>
<tr>
<td><a href="Класс/УправлениеАС/УстановитьПараметрыФайловойИБ.md">УстановитьПараметрыФайловойИБ</a></td>
<td>Устанавливает параметры доступа к файловой базе данных.</td>
</tr>
<tr>
<td><a href="Класс/УправлениеАС/УстановитьКонфигурационныйФайл.md">УстановитьКонфигурационныйФайл</a></td>
<td>Устанавливает путь к конфигурационному файлу автономного сервера.</td>
</tr>
<tr>
<td><a href="Класс/УправлениеАС/УстановитьПортПрямогоДоступа.md">УстановитьПортПрямогоДоступа</a></td>
<td>Установить порт установки прямого соединения с сервером.</td>
</tr>
<tr>
<td><a href="Класс/УправлениеАС/УстановитьПортHttpДоступа.md">УстановитьПортHttpДоступа</a></td>
<td>Установить порт установки http-соединения с сервером.</td>
</tr>
<tr>
<td><a href="Класс/УправлениеАС/Запустить.md">Запустить</a></td>
<td>Выполняет запуск автономного сервера. При ошибке запуска вызывается исключение, которео можно проверить
методом см. ЭтоИсключенияЗапускаАС
</td>
</tr>
<tr>
<td><a href="Класс/УправлениеАС/ЭтоИсключенияЗапускаАС.md">ЭтоИсключенияЗапускаАС</a></td>
<td>Проверяет, что исключение было вызвано программно при запуске автономного сервера.</td>
</tr>
<tr>
<td><a href="Класс/УправлениеАС/Запущен.md">Запущен</a></td>
<td>Проверяет запущен ли процесс автономного сервера</td>
</tr>
<tr>
<td><a href="Класс/УправлениеАС/Остановить.md">Остановить</a></td>
<td>Останавливает запущенный автономный сервер.
</td>
</tr>
</table>

## 3. Класс: КонфигурационныйФайлАС
<table bordercolor="#c0c0c0" cellpadding="3" cellspacing="0" width="100%" border="1">
<tr>
<th height="16" width="25%"><b>Метод</b></td>
Expand Down Expand Up @@ -258,6 +317,26 @@
<td>Устанавливает параметры публикации клиентских дистрибутивов (pubdst)</td>
</tr>
<tr>
<td><a href="Класс/КонфигурационныйФайлАС/ПараметрыШлюзаПрямогоДоступа.md">ПараметрыШлюзаПрямогоДоступа</a></td>
<td>Параметры доступа к информационной базе по протоколу TCP/IP (с помощью прямого подключения).</td>
</tr>
<tr>
<td><a href="Класс/КонфигурационныйФайлАС/ПараметрыШлюзаSSH.md">ПараметрыШлюзаSSH</a></td>
<td>Параметры доступа к информационной базе по протоколу SSH.</td>
</tr>
<tr>
<td><a href="Класс/КонфигурационныйФайлАС/ПараметрыФункциональностиСервера.md">ПараметрыФункциональностиСервера</a></td>
<td>Параметры функциональных характеристик автономного сервера.</td>
</tr>
<tr>
<td><a href="Класс/КонфигурационныйФайлАС/ПараметрыОтладкиСервера.md">ПараметрыОтладкиСервера</a></td>
<td>Параметры отладки текущего экземпляра автономномного сервера</td>
</tr>
<tr>
<td><a href="Класс/КонфигурационныйФайлАС/ПараметрыВнешнегоСервераОтладки.md">ПараметрыВнешнегоСервераОтладки</a></td>
<td>Параметры внешнего сервера отладки</td>
</tr>
<tr>
<td><a href="Класс/КонфигурационныйФайлАС/СоздатьКонфигурационныйФайл.md">СоздатьКонфигурационныйФайл</a></td>
<td>Создание конфигурационного файла по ранее заполненным параметрам</td>
</tr>
Expand Down
80 changes: 79 additions & 1 deletion doc/index.htm
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -190,8 +190,66 @@ <h2>1.2. Универсальные методы</h2>
<td>Возвращает код возврата последней выполненной команды.
</td>
</tr>
<tr>
<td><a href="Класс/УправлениеИБ/ОписанияРасширений.htm">ОписанияРасширений</a></td>
<td>Возвращает список расширений информационной базы в виде массива соответствий.
</td>
</tr>
</table>
<h2>2. Класс: УправлениеАС</h2>
<table bordercolor="#c0c0c0" cellpadding="3" cellspacing="0" width="100%" border="1">
<tr>
<th height="16" width="25%"><b>Метод</b></td>
<th height="16" width="75%"><b>Описание</b></td>
</tr><tr>
<td><a href="Класс/УправлениеАС/Версия.htm">Версия</a></td>
<td>Текущая версия утилиты ibsrv</td>
</tr>
<tr>
<td><a href="Класс/УправлениеАС/УстановитьВерсиюПлатформы.htm">УстановитьВерсиюПлатформы</a></td>
<td>Устанавливает версию платформы, которая будет использована для запуска утилиты ibsrv</td>
</tr>
<tr>
<td><a href="Класс/УправлениеАС/УстановитьКаталогДанных.htm">УстановитьКаталогДанных</a></td>
<td>Устанавливает путь к каталогу данных автономного сервера.</td>
</tr>
<tr>
<td><a href="Класс/УправлениеАС/УстановитьПараметрыФайловойИБ.htm">УстановитьПараметрыФайловойИБ</a></td>
<td>Устанавливает параметры доступа к файловой базе данных.</td>
</tr>
<tr>
<td><a href="Класс/УправлениеАС/УстановитьКонфигурационныйФайл.htm">УстановитьКонфигурационныйФайл</a></td>
<td>Устанавливает путь к конфигурационному файлу автономного сервера.</td>
</tr>
<tr>
<td><a href="Класс/УправлениеАС/УстановитьПортПрямогоДоступа.htm">УстановитьПортПрямогоДоступа</a></td>
<td>Установить порт установки прямого соединения с сервером.</td>
</tr>
<tr>
<td><a href="Класс/УправлениеАС/УстановитьПортHttpДоступа.htm">УстановитьПортHttpДоступа</a></td>
<td>Установить порт установки http-соединения с сервером.</td>
</tr>
<tr>
<td><a href="Класс/УправлениеАС/Запустить.htm">Запустить</a></td>
<td>Выполняет запуск автономного сервера. При ошибке запуска вызывается исключение, которео можно проверить
методом см. ЭтоИсключенияЗапускаАС
</td>
</tr>
<tr>
<td><a href="Класс/УправлениеАС/ЭтоИсключенияЗапускаАС.htm">ЭтоИсключенияЗапускаАС</a></td>
<td>Проверяет, что исключение было вызвано программно при запуске автономного сервера.</td>
</tr>
<tr>
<td><a href="Класс/УправлениеАС/Запущен.htm">Запущен</a></td>
<td>Проверяет запущен ли процесс автономного сервера</td>
</tr>
<tr>
<td><a href="Класс/УправлениеАС/Остановить.htm">Остановить</a></td>
<td>Останавливает запущенный автономный сервер.
</td>
</tr>
</table>
<h2>2. Класс: КонфигурационныйФайлАС</h2>
<h2>3. Класс: КонфигурационныйФайлАС</h2>
<table bordercolor="#c0c0c0" cellpadding="3" cellspacing="0" width="100%" border="1">
<tr>
<th height="16" width="25%"><b>Метод</b></td>
Expand Down Expand Up @@ -261,6 +319,26 @@ <h2>2. Класс: КонфигурационныйФайлАС</h2>
<td>Устанавливает параметры публикации клиентских дистрибутивов (pubdst)</td>
</tr>
<tr>
<td><a href="Класс/КонфигурационныйФайлАС/ПараметрыШлюзаПрямогоДоступа.htm">ПараметрыШлюзаПрямогоДоступа</a></td>
<td>Параметры доступа к информационной базе по протоколу TCP/IP (с помощью прямого подключения).</td>
</tr>
<tr>
<td><a href="Класс/КонфигурационныйФайлАС/ПараметрыШлюзаSSH.htm">ПараметрыШлюзаSSH</a></td>
<td>Параметры доступа к информационной базе по протоколу SSH.</td>
</tr>
<tr>
<td><a href="Класс/КонфигурационныйФайлАС/ПараметрыФункциональностиСервера.htm">ПараметрыФункциональностиСервера</a></td>
<td>Параметры функциональных характеристик автономного сервера.</td>
</tr>
<tr>
<td><a href="Класс/КонфигурационныйФайлАС/ПараметрыОтладкиСервера.htm">ПараметрыОтладкиСервера</a></td>
<td>Параметры отладки текущего экземпляра автономномного сервера</td>
</tr>
<tr>
<td><a href="Класс/КонфигурационныйФайлАС/ПараметрыВнешнегоСервераОтладки.htm">ПараметрыВнешнегоСервераОтладки</a></td>
<td>Параметры внешнего сервера отладки</td>
</tr>
<tr>
<td><a href="Класс/КонфигурационныйФайлАС/СоздатьКонфигурационныйФайл.htm">СоздатьКонфигурационныйФайл</a></td>
<td>Создание конфигурационного файла по ранее заполненным параметрам</td>
</tr>
Expand Down
27 changes: 27 additions & 0 deletions doc/Класс/КонфигурационныйФайлАС/ПараметрыВнешнегоСервераОтладки.htm
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
<!DOCTYPE html>
<html>
<head>
<title>Метод ПараметрыВнешнегоСервераОтладки</title>
<meta charset="utf-8">
<link href="../../css/default.css" rel="stylesheet">
</head>
<body>
<h1 class="small">Программный интерфейс библиотеки ibcmdrunner</h1>
<hr style="height:0px">
<h1>ПараметрыВнешнегоСервераОтладки</h1>
<p class="funcdesc">Параметры внешнего сервера отладки<br /></p><h2>Параметры:</h2><table>
<tr>
<th height="16" width="10%"><b>№ п/п</b></th>
<th height="16" width="20%"><b>Имя параметра</b></th>
<th height="16" width="10%"><b>Обязательный</b></th>
<th height="16" width="20%"><b>Тип параметра</b></th>
<th height="16" width="40%"><b>Описание</b></th>
</tr><tr>
<td >1</td>
<td >АдресВнешнегоСервераОтладки</td>
<td >Да</td>
<td >Строка</td>
<td >Адрес внешнего сервера отладки.
</td>
</tr></table><h2>Возвращаемое значение:</h2>
<b>Нет. </b><br /></body></html>
18 changes: 18 additions & 0 deletions doc/Класс/КонфигурационныйФайлАС/ПараметрыВнешнегоСервераОтладки.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@

<h1>ПараметрыВнешнегоСервераОтладки</h1>
<p class="funcdesc">Параметры внешнего сервера отладки<br /></p><h2>Параметры:</h2><table>
<tr>
<th height="16" width="10%"><b>№ п/п</b></th>
<th height="16" width="20%"><b>Имя параметра</b></th>
<th height="16" width="10%"><b>Обязательный</b></th>
<th height="16" width="20%"><b>Тип параметра</b></th>
<th height="16" width="40%"><b>Описание</b></th>
</tr><tr>
<td >1</td>
<td >АдресВнешнегоСервераОтладки</td>
<td >Да</td>
<td >Строка</td>
<td >Адрес внешнего сервера отладки.
</td>
</tr></table><h2>Возвращаемое значение:</h2>
<b>Нет. </b><br />
45 changes: 45 additions & 0 deletions doc/Класс/КонфигурационныйФайлАС/ПараметрыОтладкиСервера.htm
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
<!DOCTYPE html>
<html>
<head>
<title>Метод ПараметрыОтладкиСервера</title>
<meta charset="utf-8">
<link href="../../css/default.css" rel="stylesheet">
</head>
<body>
<h1 class="small">Программный интерфейс библиотеки ibcmdrunner</h1>
<hr style="height:0px">
<h1>ПараметрыОтладкиСервера</h1>
<p class="funcdesc">Параметры отладки текущего экземпляра автономномного сервера<br /></p><h2>Параметры:</h2><table>
<tr>
<th height="16" width="10%"><b>№ п/п</b></th>
<th height="16" width="20%"><b>Имя параметра</b></th>
<th height="16" width="10%"><b>Обязательный</b></th>
<th height="16" width="20%"><b>Тип параметра</b></th>
<th height="16" width="40%"><b>Описание</b></th>
</tr><tr>
<td >1</td>
<td >ТипОтладки</td>
<td >Нет</td>
<td >Строка</td>
<td >Режим работы отладчика. (none|tcp|http)</td>
</tr><tr>
<td >2</td>
<td >ПортОтладки</td>
<td >Нет</td>
<td >Число</td>
<td >Сетевой порт, обслуживаемый сервером отладки</td>
</tr><tr>
<td >3</td>
<td >СетевойИнтерфейс</td>
<td >Нет</td>
<td >Строка</td>
<td >IP-адрес, обслуживаемый сервером для отладки</td>
</tr><tr>
<td >4</td>
<td >ПарольОтладки</td>
<td >Нет</td>
<td >Строка</td>
<td >Пароль для доступа к серверу отладки.
</td>
</tr></table><h2>Возвращаемое значение:</h2>
<b>Нет. </b><br /></body></html>
36 changes: 36 additions & 0 deletions doc/Класс/КонфигурационныйФайлАС/ПараметрыОтладкиСервера.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@

<h1>ПараметрыОтладкиСервера</h1>
<p class="funcdesc">Параметры отладки текущего экземпляра автономномного сервера<br /></p><h2>Параметры:</h2><table>
<tr>
<th height="16" width="10%"><b>№ п/п</b></th>
<th height="16" width="20%"><b>Имя параметра</b></th>
<th height="16" width="10%"><b>Обязательный</b></th>
<th height="16" width="20%"><b>Тип параметра</b></th>
<th height="16" width="40%"><b>Описание</b></th>
</tr><tr>
<td >1</td>
<td >ТипОтладки</td>
<td >Нет</td>
<td >Строка</td>
<td >Режим работы отладчика. (none|tcp|http)</td>
</tr><tr>
<td >2</td>
<td >ПортОтладки</td>
<td >Нет</td>
<td >Число</td>
<td >Сетевой порт, обслуживаемый сервером отладки</td>
</tr><tr>
<td >3</td>
<td >СетевойИнтерфейс</td>
<td >Нет</td>
<td >Строка</td>
<td >IP-адрес, обслуживаемый сервером для отладки</td>
</tr><tr>
<td >4</td>
<td >ПарольОтладки</td>
<td >Нет</td>
<td >Строка</td>
<td >Пароль для доступа к серверу отладки.
</td>
</tr></table><h2>Возвращаемое значение:</h2>
<b>Нет. </b><br />
5 changes: 3 additions & 2 deletions doc/Класс/КонфигурационныйФайлАС/ПараметрыСервера.htm
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ <h1>ПараметрыСервера</h1>
</tr><tr>
<td >1</td>
<td >Адрес</td>
<td >Да</td>
<td >Нет</td>
<td >Строка</td>
<td >IP-адрес автономного сервера</td>
</tr><tr>
Expand All @@ -33,6 +33,7 @@ <h1>ПараметрыСервера</h1>
<td >ИмяХоста</td>
<td >Нет</td>
<td >Строка</td>
<td >имя хоста (необязательный)</td>
<td >имя хоста (необязательный)
</td>
</tr></table><h2>Возвращаемое значение:</h2>
<b>Нет. </b><br /></body></html>
5 changes: 3 additions & 2 deletions doc/Класс/КонфигурационныйФайлАС/ПараметрыСервера.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
</tr><tr>
<td >1</td>
<td >Адрес</td>
<td >Да</td>
<td >Нет</td>
<td >Строка</td>
<td >IP-адрес автономного сервера</td>
</tr><tr>
Expand All @@ -24,6 +24,7 @@
<td >ИмяХоста</td>
<td >Нет</td>
<td >Строка</td>
<td >имя хоста (необязательный)</td>
<td >имя хоста (необязательный)
</td>
</tr></table><h2>Возвращаемое значение:</h2>
<b>Нет. </b><br />
Loading