Skip to content

Commit

Permalink
Updated docs
Browse files Browse the repository at this point in the history
  • Loading branch information
ekorneechev committed Mar 15, 2022
1 parent 231b601 commit fdf95bf
Show file tree
Hide file tree
Showing 5 changed files with 21 additions and 9 deletions.
Binary file modified docs/_img/params2.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
13 changes: 9 additions & 4 deletions docs/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -140,7 +140,7 @@ <h3>git &amp; make<a class="headerlink" href="#git-make" title="Ссылка н
</div>
<p>Есть возможность сменить программу для RDP-соединения - Remmina или FreeRDP. Для подключения по VNC тоже есть два варианта - Remmina и vncviewer (любая программа, предоставляющая данный функционал). По умолчанию подключение по RDP настроено через FreeRDP, VNC - через vncviewer.</p>
<p>Также Вы можете настроить отображение определенного протокола на главном окне приложения по умолчанию и сортировку для <a class="reference internal" href="index.html#rst-list"><span class="std std-ref">Список сохраненных подключений</span></a>.</p>
<p>На вкладке «Расширенные» настраивается отображение значка в трее, проверка обновлений программы, ведение логов и редактор для файлов подключений. Есть возможность очистить базу адресов серверов, к которым было совершено подключение (выпадающий список при вводе адреса на главном окне или в доп. параметрах), и <a class="reference internal" href="index.html#rst-list"><span class="std std-ref">Список сохраненных подключений</span></a>. Или произвести сброс всех параметров программы.</p>
<p>На вкладке "Расширенные" настраивается отображение значка в трее, проверка обновлений программы, ведение логов, редактор для файлов подключений и сохранение паролей. Есть возможность очистить базу адресов серверов, к которым было совершено подключение (выпадающий список при вводе адреса на главном окне или в доп. параметрах), <a class="reference internal" href="index.html#rst-list"><span class="std std-ref">cписок сохраненных подключений</span></a> и сохраненные пароли. Или произвести сброс всех параметров программы.</p>
<div class="figure align-default">
<img alt="_img/params2.png" src="_img/params2.png" />
</div>
Expand All @@ -163,12 +163,13 @@ <h3>git &amp; make<a class="headerlink" href="#git-make" title="Ссылка н
</div>
<p>Сохраненные подключения в списке представляют собой файлы с расширением .myc, сохраняемые в домашней папке текущего пользователя в папке .myconnector. Эти файлы возможно открывать на других компьютерах с установленным MyConnector или редактировать в любом удобном текстовом редакторе.</p>
<p>При двойном щелчке на одном из подключений произойдет запуск требуемой программы для соединения (или нажатие правой кнопкой мыши на нужном соединении и далее выбрать пункт меню «Подключение»).</p>
<p>Также через нажатие правой кнопки мыши на любом из сохраненных соединений, Вы можете выбрать пункт «Изменить» - тогда откроется окно дополнительных настроек данного подключения с заполненными полями. При выборе пункта «Копировать» - откроется такое же окно, однако при сохранении добавится новое подключение с измененными Вами параметрами. При выборе пункта «Удалить» - Вы удалите подключение из списка.</p>
<p>Также через нажатие правой кнопки мыши на любом из сохраненных соединений, Вы можете выбрать пункт "Изменить" - тогда откроется окно дополнительных настроек данного подключения с заполненными полями. При выборе пункта "Копировать" - откроется такое же окно, однако при сохранении добавится новое подключение с измененными Вами параметрами. При выборе пункта "Переименовать" - откроется диалоговое окно переименования подключения (без открытия свойств самого подключения). При выборе пункта "Удалить" - Вы удалите подключение из списка.</p>
<p>Пункт данного меню «Сохранить ярлык» позволяет создать кнопку запуска приложения MyConnector с быстрым подключением к выбранному соединению в любом месте на Вашем компьютере (по умолчанию на рабочем столе). Также это можно сделать простым перетаскиванием подключения в нужное место. Формат команды:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span>$ myconnector -c|--connection &lt;имя_подключения&gt;
</pre></div>
</div>
<p>Пункт "Автозапуск подключения" позволяет настроить запускать ли данное подключение при входе пользователя в сеанс или нет. Если включить - то в папке <code class="docutils literal notranslate"><span class="pre">$HOME/.config/autostart</span></code> создаться ярлык запуска подключения, если выключить - удалится при наличии.</p>
<p>Пункт "Открыть как текст" позволяет открыть файл подключения в текстовом редакторе, указанном в настройках программы на вкладке «Расширенные» (<a class="reference internal" href="index.html#rst-prog-settings"><span class="std std-ref">Параметры программы</span></a>).</p>
<p>Список поддерживает сортировку и группировку (группа указывается в <a class="reference internal" href="index.html#rst-conn-settings"><span class="std std-ref">Дополнительные параметры подключений</span></a>).</p>
</div>
<span id="document-kiosk"></span><div class="section" id="rst-kiosk">
Expand Down Expand Up @@ -295,6 +296,10 @@ <h3>Конфигурационный файл<a class="headerlink" href="#id5" t
</div>
<span id="document-other"></span><div class="section" id="rst-other">
<span id="id1"></span><h2>Прочие возможности<a class="headerlink" href="#rst-other" title="Ссылка на этот заголовок"></a></h2>
<div class="section" id="search">
<h3>Поиск по списку подключений (фильтр)<a class="headerlink" href="#search" title="Ссылка на этот заголовок"></a></h3>
<p>В нижней части главного окна программы есть поле для ввода поискового запроса (можно нажать Ctrl+F для установки фокуса на данное поле). Поддерживается инверсия русской и английской раскладки клавиатуры (например при вводе <i>ыукмук</i> найдется <i>server</i>).</p>
</div>
<div class="section" id="id6">
<h3>Открытие файлов<a class="headerlink" href="#id6" title="Ссылка на этот заголовок"></a></h3>
<p>В программе есть возможность открытия файлов .myc, .rdp и .remmina. Для этого в пункте меню «Файл» выберите «Открыть», либо дважды щелкните на нем в файловом менеджере. После выбора необходимого файла будет произведена попытка соединения - если файл не содержит параметров или содержит ошибки, то отобразится соответствующее сообщение. В другом случае - произойдет успешное подключение к серверу.</p>
Expand All @@ -307,7 +312,7 @@ <h3>Импорт файлов<a class="headerlink" href="#id7" title="Ссылк
usage: ctor2myc [-v] input.ctor [output.myc]
</pre></div>
</div>
<p>Также при первом запуске MyConnector и при наличие рабочей папки .connector в домашней папке пользователя будет выдан запрос на автоматический импорт всех имеющихся там соединений.</p>
<p>Также при первом запуске MyConnector и при наличии в рабочей папке .connector в домашней папке пользователя файлов подключения Connector будет выдан запрос на автоматический импорт всех имеющихся там соединений.</p>
</div>
<div class="section" id="id8">
<h3>Ведение логов<a class="headerlink" href="#id8" title="Ссылка на этот заголовок"></a></h3>
Expand All @@ -319,7 +324,7 @@ <h3>Текстовый редактор для подключений<a class="h
</div>
<div class="section" id="id10">
<h3>Справка по программе MyConnector<a class="headerlink" href="#id10" title="Ссылка на этот заголовок"></a></h3>
<p>Ссылка на данную страницу Wiki всегда доступна из приложения - пункт главного меню «Справка». Там же краткие сведения о программе и об ее разработчике. Также справочную информацию можно просмотреть и на компьютере (данную вики планируется разместить в отдельном пакете <code class="docutils literal notranslate"><span class="pre">myconnector-docs</span></code>):</p>
<p>Ссылка на данную страницу Wiki всегда доступна из приложения - пункт главного меню "Справка". Там же краткие сведения о программе и об ее разработчике. Также справочную информацию можно просмотреть и на компьютере (данную вики размещена в отдельном пакете <code class="docutils literal notranslate"><span class="pre">myconnector-docs</span></code>):</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span>$ man myconnector
$ myconnector --help
</pre></div>
Expand Down
4 changes: 3 additions & 1 deletion docs/list.rst
Original file line number Diff line number Diff line change
Expand Up @@ -26,12 +26,14 @@

При двойном щелчке на одном из подключений произойдет запуск требуемой программы для соединения (или нажатие правой кнопкой мыши на нужном соединении и далее выбрать пункт меню "Подключение").

Также через нажатие правой кнопки мыши на любом из сохраненных соединений, Вы можете выбрать пункт "Изменить" - тогда откроется окно дополнительных настроек данного подключения с заполненными полями. При выборе пункта "Копировать" - откроется такое же окно, однако при сохранении добавится новое подключение с измененными Вами параметрами. При выборе пункта "Удалить" - Вы удалите подключение из списка.
Также через нажатие правой кнопки мыши на любом из сохраненных соединений, Вы можете выбрать пункт "Изменить" - тогда откроется окно дополнительных настроек данного подключения с заполненными полями. При выборе пункта "Копировать" - откроется такое же окно, однако при сохранении добавится новое подключение с измененными Вами параметрами. При выборе пункта "Переименовать" - откроется диалоговое окно переименования подключения (без открытия свойств самого подключения). При выборе пункта "Удалить" - Вы удалите подключение из списка.

Пункт данного меню "Сохранить ярлык" позволяет создать кнопку запуска приложения MyConnector с быстрым подключением к выбранному соединению в любом месте на Вашем компьютере (по умолчанию на рабочем столе). Также это можно сделать простым перетаскиванием подключения в нужное место. Формат команды::

$ myconnector -c|--connection <имя_подключения>

Пункт "Автозапуск подключения" позволяет настроить запускать ли данное подключение при входе пользователя в сеанс или нет. Если включить - то в папке ``$HOME/.config/autostart`` создаться ярлык запуска подключения, если выключить - удалится при наличии.

Пункт "Открыть как текст" позволяет открыть файл подключения в текстовом редакторе, указанном на вкладке "Расширенные" в :ref:`rst-prog-settings`.

Список поддерживает сортировку и группировку (группа указывается в :ref:`rst-conn-settings`).
9 changes: 7 additions & 2 deletions docs/other.rst
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,11 @@
Прочие возможности
==================

Поиск по списку подключений (фильтр)
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

В нижней части главного окна программы есть поле для ввода поискового запроса (можно нажать :guilabel:`&Ctrl` + :guilabel:`&F` для установки фокуса на данное поле). Поддерживается инверсия русской и английской раскладки клавиатуры (например при вводе *ыукмук* найдется *server*).

Открытие файлов
~~~~~~~~~~~~~~~

Expand All @@ -33,7 +38,7 @@
$ ctor2myc
usage: ctor2myc [-v] input.ctor [output.myc]

Также при первом запуске MyConnector и при наличие рабочей папки .connector в домашней папке пользователя будет выдан запрос на автоматический импорт всех имеющихся там соединений.
Также при первом запуске MyConnector и при наличии в рабочей папке .connector в домашней папке пользователя файлов подключения Connector будет выдан запрос на автоматический импорт всех имеющихся там соединений.

Ведение логов
~~~~~~~~~~~~~
Expand All @@ -48,7 +53,7 @@
Справка по программе MyConnector
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Ссылка на данную страницу Wiki всегда доступна из приложения - пункт главного меню "Справка". Там же краткие сведения о программе и об ее разработчике. Также справочную информацию можно просмотреть и на компьютере (данную вики планируется разместить в отдельном пакете ``myconnector-docs``)::
Ссылка на данную страницу Wiki всегда доступна из приложения - пункт главного меню "Справка". Там же краткие сведения о программе и об ее разработчике. Также справочную информацию можно просмотреть и на компьютере (данную вики размещена в отдельном пакете ``myconnector-docs``)::

$ man myconnector
$ myconnector --help

0 comments on commit fdf95bf

Please sign in to comment.