Слияние ветки 'man-pages' с 'master'

Добавлены rst заготовки для man страниц Посмотреть запрос на слияние !1

Слияние ветки 'man-pages' с 'master'
Добавлены rst заготовки для man страниц Посмотреть запрос на слияние !1
1cc711f9 · Проскурнев Артем Сергеевич · 61b7163f · 8ecbd759 · 1cc711f9 · 1cc711f9
--- a/mos-auth-config/man/mos-auth-config.8.rst
+++ b/mos-auth-config/man/mos-auth-config.8.rst
+.. |NAME| replace:: mos-auth-config
+.. |GROUP_NAME| replace:: mos-auth
+.. |CONFIG_FILE| replace:: mos-auth.conf
+.. |CONFIG_FILE_PATH| replace:: /etc/mos-auth/|CONFIG_FILE|
+
+========
+ |NAME|
+========
+
+--------------------------------------------------------
+command-line program to control ``mos-auth`` subsystem.
+--------------------------------------------------------
+
+:Date: 17 May, 2024
+:Manual section: 8
+:Manual group: |GROUP_NAME|
+
+SYNOPSIS
+========
+
+|NAME| <COMMAND>
+
+DESCRIPTION
+===========
+
+|NAME| allows to enable or disable logging in through an account mos.ru.
+
+COMMANDS
+========
+
+``enable``
+	| Enable `mos-auth` subsystem. ``Administrator rights`` are required to run this command.
+
+	| When enabled, the following actions are performed:
+
+		* the `mos-auth` theme is installed in ``SDDM``,
+		* the ``PAM`` mechanism for auto-cleaning the guest profile is installed,
+		* ``network folders`` support is enabled (if the `mos-auth-folders` package is installed).
+
+``disable``
+	| Disable `mos-auth` subsystem. ``Administrator rights`` are required to run this command.
+
+	| When disabled, the following actions are performed:
+
+		* the ``SDDM theme`` that was configured before switching on is returned,
+		* the ``PAM`` mechanism for auto-cleaning the guest profile is turned off,
+		* support for ``network folders`` is turned off.
+
+``status``
+	| Show current state of `mos-auth` subsystem.
+
+``edit``
+	| Edit config file. ``Administrator rights`` are required to run this command.
+
+``help``
+	| Show help message.
+
+FILES
+=====
+
+|CONFIG_FILE_PATH|
+	System configuration file
+
+SEE ALSO
+========
+
+|CONFIG_FILE|\(5\)
+
+AUTHOR
+======
+MOS Team
--- a/mos-auth-config/man/mos-auth-config.8.ru.rst
+++ b/mos-auth-config/man/mos-auth-config.8.ru.rst
+.. |NAME| replace:: mos-auth-config
+.. |GROUP_NAME| replace:: mos-auth
+.. |CONFIG_FILE| replace:: mos-auth.conf
+.. |CONFIG_FILE_PATH| replace:: /etc/mos-auth/|CONFIG_FILE|
+
+========
+ |NAME|
+========
+
+-----------------------------------------------------------------------
+консольная утилита для управления подсистемой авторизации ``mos-auth``.
+-----------------------------------------------------------------------
+
+:Date: 17 Мая, 2024
+:Manual section: 8
+:Manual group: |GROUP_NAME|
+
+СИНТАКСИС
+=========
+
+|NAME| <COMMAND>
+
+ОПИСАНИЕ
+========
+
+|NAME| позволяет включать и отключать вход в систему через учетную запись на mos.ru.
+
+КОМАНДЫ
+=======
+
+``enable``
+	| Включение подсистемы авторизации `mos-auth`. Для запуска этой команды требуются ``права администратора``.
+
+	| При включении выполняются следующие действия:
+
+		* устанавливается тема `mos-auth` в ``SDDM``,
+		* устанавливается ``PAM``-механизм автоочистки профиля гостя,
+		* включается поддержка ``сетевых папок`` (если установлен пакет `mos-auth-folders`).
+
+``disable``
+	| Выключение подсистемы авторизации `mos-auth`. Для запуска этой команды требуются ``права администратора``.
+
+	| При выключении выполняются следующие действия:
+
+		* возвращается ``тема SDDM``, которая была настроена до включения подсистемы авторизации,
+		* выключается ``PAM``-механизм автоочистки профиля гостя,
+		* выключается поддержка ``сетевых папок``.
+
+``status``
+	| Вывод текущего статуса авторизации через ``mos.ru`` в системе.
+
+``edit``
+	| Редактирование конфигурационного файла. Для запуска этой команды требуются ``права администратора``.
+
+``help``
+	| Вызов справки.
+
+ФАЙЛЫ
+=====
+
+|CONFIG_FILE_PATH|
+	Системный конфигурационный файл
+
+СМОТРИТЕ ТАКЖЕ
+==============
+
+|CONFIG_FILE|\(5\)
+
+АВТОР
+=====
+MOS Team
--- a/mos-auth-config/man/mos-auth.conf.5.rst
+++ b/mos-auth-config/man/mos-auth.conf.5.rst
+.. |NAME| replace:: mos-auth-config
+.. |GROUP_NAME| replace:: mos-auth
+.. |CONFIG_FILE| replace:: mos-auth.conf
+.. |CONFIG_FILE_PATH| replace:: /etc/mos-auth/|CONFIG_FILE|
+
+===============
+ |CONFIG_FILE|
+===============
+
+---------------------
+|NAME| configuration
+---------------------
+
+:Date: 17 May, 2024
+:Manual section: 5
+:Manual group: |GROUP_NAME|
+
+DESCRIPTION
+===========
+
+Configuration loads from system config file.
+
+|CONFIG_FILE_PATH|
+	System configuration file
+
+This file configures various parameters of the `mos-auth` subsystem.
+If this file is not available, default values are used.
+
+OPTIONS
+=======
+
+[sddm] section:
+
+The ``sddm`` section contains the parameters for the login authorization screen.
+
+`guest-enabled=`
+	When enabled, button for ``login as guest`` is displayed.
+
+	Default value is **true**.
+
+`guest-home-tmpfs=`
+	When enabled, guest profile (`/home` dir) is mounted via ``tmpfs``.
+
+	It means all files in the guest's home directory will be located in RAM. However, this increases security, as the guest profile will be cleared automatically upon reboot, and also increases the speed of creating / clearing a guest when logging into the guest account.
+
+	Default value is **false**.
+
+`mos-auth-btn-enabled=`
+	When enabled, button for ``login through mos.ru account`` is displayed.
+
+	Default value is **true**.
+
+SEE ALSO
+========
+
+|NAME|\(8\)
+
+AUTHOR
+======
+MOS Team
+
--- a/mos-auth-config/man/mos-auth.conf.5.ru.rst
+++ b/mos-auth-config/man/mos-auth.conf.5.ru.rst
+.. |NAME| replace:: mos-auth-config
+.. |GROUP_NAME| replace:: mos-auth
+.. |CONFIG_FILE| replace:: mos-auth.conf
+.. |CONFIG_FILE_PATH| replace:: /etc/mos-auth/|CONFIG_FILE|
+
+===============
+ |CONFIG_FILE|
+===============
+
+-----------------------
+конфигурация для |NAME|
+-----------------------
+
+:Date: 17 Мая, 2024
+:Manual section: 5
+:Manual group: |GROUP_NAME|
+
+ОПИСАНИЕ
+========
+
+Конфигурация загружается из системного конфигурационного файла.
+
+|CONFIG_FILE_PATH|
+	Системный конфигурационный файл
+
+Этот файл настраивает различные параметры подсистемы авторизации `mos-auth`.
+В случае отсутствия этого файла используются стандартные значения.
+
+ОПЦИИ
+=====
+
+Секция [sddm]:
+
+В секции ``sddm`` представлены параметры для экрана входа авторизации.
+
+`guest-enabled=`
+	Если включено, тогда отображается кнопка ``Войти как гость``.
+
+	Значение по умолчанию: **true**.
+
+`guest-home-tmpfs=`
+	Если включено, тогда профиль гостя (домашняя папка `/home`) примонтирована через ``tmpfs``.
+
+	Это означает что все файлы в домашней папке гостя будут располагаться в ОЗУ. Однако, это повышает безопасность, так как профиль гостя будет очищаться автоматически при перезагрузке, а также это повышает скорость создания / очистки профиля гостя при входе в учетную запись гостя.
+
+	Значение по умолчанию: **false**.
+
+`mos-auth-btn-enabled=`
+	Если включено, тогда отображается кнопка ``Авторизация через mos.ru``
+
+	Значение по умолчанию: **true**.
+
+СМОТРИТЕ ТАКЖЕ
+==============
+
+|NAME|\(8\)
+
+АВТОР
+=====
+MOS Team
+
--- a/mos-auth-config/mos-auth.conf
+++ b/mos-auth-config/mos-auth.conf
+# В секции sddm представлены параметры для экрана входа авторизации.
+#
+# Подробнее: man mos-auth.conf
+#
+# guest-enabled - Значение по умолчанию: true
+# Параметр отвечает за отображение кнопки входа в учётную запись гостя.
+#
+# guest-home-tmpfs - Значение по умолчанию: false
+# Параметр отвечает за монтирование домашней папки гостя в tmpfs.
+#
+# mos-auth-btn-enabled - Значение по умолчанию: true
+# Параметр отвечает за отображение кнопки входа через mos.ru.
+
+[sddm]
+#guest-enabled=true
+#guest-home-tmpfs=false
+#mos-auth-btn-enabled=true