winehelper/README.MD

== О программе ==
WineHelper — это инструмент для упрощения установки Windows-приложений на Linux. Он использует подготовленные скрипты, портативные версии Wine и изолированные префиксы, обеспечивая максимальную повторяемость на различных системах, начиная с релиза [[p10]] и выше.

== Установка ==
 $ su -
 # apt-get update && apt-get dist-upgrade
 # apt-get install winehelper
 # exit

== Использование WineHelper ==
=== Список приложений для установки  ===
Вывод списка приложений, доступных к установке:
 $ winehelper install list
или сокращенная команда:
 $ winehelper -i

=== Запуск установки приложений  ===
Скрипты установки разделены на два типа:

'''Список программ с возможностью автоматической установки''' — содержит полностью автоматизированные скрипты установок программ у который есть дистрибутивы (установщики) в свободном доступе.
Процесс полностью автоматизирован.
Пример:
 $ winehelper install spravki-bk
или сокращенная команда:
 $ winehelper -i spravki-bk

'''Список программ с возможностью установки из существующего дистрибутива''' — содержит скрипты установок для программ, которых нет в свободном доступе.
Пример:
 $ winehelper install is-record-station "/путь/до/установочного_файла"
или сокращенная команда:
 $ winehelper -i is-record-station "/путь/до/установочного_файла"

=== Процесс установки приложений  ===

При первом запуске ''WineHelper'' проверяются и при необходимости устанавливаются дополнительные зависимости (запрашиваются права root).

Процесс установки приложений:
# Отображаются лицензионные соглашения на сторонние компоненты. Для продолжения введите '''y''' и нажмите '''Enter'''.
# Далее процесс проходит автоматически с подробным выводом в терминал:
## Загрузка и проверка хэш-суммы нужной версии Wine.
## Загрузка и проверка хэш-суммы базового префикса.
## Инициализация и подготовка префикса.
## Скачивание дистрибутива (установщика) программы с официального сайта (если применимо).
## Установка приложения.
## Создание .desktop-файла (ярлыка) на рабочем столе и в меню приложений.

Если устанавливаемое приложение требует дополнительных действий от пользователя (ввод лицензии, настройка), это будет явно указано в терминале.

=== Удаление префикса с приложением  ===
Для удаления префикса выполните команду:
 $ winehelper remove-prefix [имя_префикса]
Если имя префикса не указано, будет выведен список существующих префиксов:
 0 - Отмена
 1 - Префикс1
 2 - Префикс2
 Выберите префикс (0-2):
Необходимо указать номер, удаляемого префикса и нажать клавишу '''Enter'''. Далее потребуется подтвердить удаление префикса, вводом '''y'''. 

В результате будут удалены:
*сам префикс;
*установленное ПО;
*.desktop-файлы (ярлыки для установленного ПО в префиксе).

=== Создание резервной копии префикса ===
Команда создания резервной копии префикса:
 $ winehelper backup-prefix [имя_префикса]
Если имя префикса не указано, будет выведен список существующих префиксов:
 0 - Отмена
 1 - Префикс1
 2 - Префикс2
 Выберите префикс (0-2):
Необходимо указать номер, удаляемого префикса и нажать клавишу '''Enter'''.
После выбора префикса автоматически:
# Создаётся копия префикса.
# Внутри префикса сохраняется используемая версия WINE.
# Копируются иконки для ярлыков (.desktop-файлов).
# Сохраняется информация о ярлыках (.desktop-файлах) для будущей распаковки префикса.
# Резервная копия сохраняется на рабочем столе с именем: {{path|backup_имя_префикса_дата_создания.whpack}}

=== Восстановление префикса из резервной копии ===
Команда восстановления префикса из резервной копии:
 $ winehelper restore-prefix "путь/до/файла.whpack"

Восстановление префикса не требует подключение к интернету и происходит в автоматическом режиме:
# Распаковка префикса.
# Восстановление версии WINE.
# Восстановление ярлыков (.esktop-файdлов).

После завершения восстановления приложение доступно для запуска через меню или рабочий стол.

=== Использование команд WINE в WineHelper  ===

WineHelper предоставляет доступ к основным инструментам WINE:
 winehelper winefile                  # запуск файлового менеджера wine
 winehelper winecfg                   # запуск wine конфигуратора для префикса
 winehelper winereg                   # запуск редактора реестра для префикса
 winehelper wineconsole               # запуск терминала wine (cmd.exe)
 winehelper winetricks                # запуск графического интерфейса winetricks
 winehelper winetricks [компонент]    # автоматическая установка дополнительного компонента в префикс
После выполнения любой из вышеперечисленных команд отображается список существующих префиксов:
 0 - Отмена
 1 - Префикс1
 2 - Префикс2
 Выберите префикс (0-2):
Команда выполняется в выбранном вами префиксе.

=== Запуск стороннего *.exe файла в WineHelper  ===
Есть 2 варианта:

'''1. В командной строке выполнить команду:'''
 $ winehelper "путь/до/файла.exe"
 0 - Отмена
 1 - Префикс1
 2 - Префикс2
 Выберите префикс (0-2):
Файл будет запущен в выбранном префиксе.


'''2. С помощью файлового менеджера WINE:'''
 $ winehelper winefile
 0 - Отмена
 1 - Префикс1
 2 - Префикс2
 Выберите префикс (0-2):
В файловом менеджере найти и запустить нужный exe-файл.

=== Дополнительные команды  ===
 winehelper help
Вывод:
<pre>
Использование: winehelper [команда]

Команды:
    install list                    список возможных установочных скриптов
    install [скрипт]                запустить скрипт установки программы
    install [скрипт] --clear-pfx    не использовать готовый префикс для установки ПО

    installed                       список установленных программ
    run [программа]                 запуск программы (отладка)
    remove-all                      удалить WineHelper и все связанные данные
    remove-prefix [имя_префикса]    удалить префикс и все связанные данные
    backup-prefix [имя_префикса]    создать резервную копию префикса
    restore-prefix "путь/до/whpack" восстановить префикс из резервной копии

Параметры:
    --help                          показать эту справку и выйти
    --version                       показать информацию о пакете и его версии
    --debug [команда]               включить режим логирования работы WINE
</pre>