Инструкция по работе с архиватором «Друг».

1. О приложении.

Приложение "Архиватор «Друг»" это бесплатное приложение предназначено для создания резервных копий данных. Для реализации автоматического архивирования данных, в приложении реализована возможность сохранения настроенной конфигурации задания архивирования в файл "*.bfs", который в дальнейшем можно открыть в приложении для изменения конфигурации задания архивирования или использовать этот файл для уже непосредственной реализации архивирования указанной в файле конфигурации задания архивирования.

После сохранения конфигурации архивирования данных, в планировщик задания можно добавить задание на периодическое архивирование, где в качестве запуска программы следует указать путь к файлу приложения "BackupFriend.exe" с добавленным к нему аргументом файла конфигурации данных "arch.bfs". Например:
"C:\Program Files (x86)\George Paradox\Архиватор друг\BackupFriend.exe D:\Rezerv Config\arch.bfs"

Вместо файла конфигурации в качестве аргумента можно так же указать непосредственно нужные ключи, но удобнее указать именно файл конфигурации, который представляет из себя текстовый файл с уже заполненными инструкциями-ключами для запуска архивирования данных.

2. Главное окно.

Главное окно архиватора состоит из трёх частей:

1. Панель управления;
2. Панель кнопок быстрого открытия заданий архивирования;
3. Поле отчёта;

3. Панель управления.

На панели управления располагается меню, панель кнопок быстрого доступа, и панель управления отчётом и ошибками.

Меню состоит из трёх пунктов:

• «Файл» - содержит подпункты для управления заданиями архивирования, и пункт смены наименования кнопок на панели быстрого доступа;
• «Отчет» - меню управление отчётом;
• «Настройки» - открывает окно для управления настройками архиватора.

3.1 Файл.

Меню « Новое задание архивирования» открывает окно для создания и настройки нового задания архивирования. Аналогичная кнопка так же располагается на панели кнопок быстрого доступа.

Меню « Открыть задание архивирование» открывает диалоговое окно для выбора файла конфигурации архивирования с расширением «*.bfs»,   которое позволит загрузить и открыть окно ранее сохранённого задания архивирования.

Меню « Сменить наименование кнопок быстрой загрузки» изменяет наименование кнопок быстрого открытия заданий архивирования. Кнопки могут именоваться как полный путь к файлу, в котором храниться конфигурация для задания архивирования, либо как пользовательское наименование задания архивирования. Нажатие кнопки приводит к изменению наименования кнопок быстрого открытия задания архивирования.

3.2. Отчет.

Меню « Перейти к предыдущей ошибке» и « Перейти к следующей ошибке» позволяет переходить от ошибки к ошибке в поле отчёта. Аналогичные кнопки имеются на панели кнопок быстрого доступа.

Меню « Очистить отчёт» полностью очищает поле отчёта. Аналогичная кнопка имеется на панели кнопок быстрого доступа.

4. Настройки.

Меню «Настройки» открывает одноименное окно для установок настроек программы.

Если установлен параметр «Автозапуск при старте Windows» то архиватор автоматически запуститься сразу после загрузки операционной системы.

Если установлен параметр «Запускать в трее», то при запуске архиватора окно архиватора будет сразу же свёрнуто в системный трей.

Если установлен параметр «Минимизировать в трей при закрытии», то при закрытии приложения через кнопку, расположенную в правом верхнем углу окна (X), архиватор будет не закрыт, а всего лишь свёрнут в системный трей. При нажатии же пункта "Выход" из подменю верхнего меню "Файл", приложении будет именно закрыто.

В значении поля "Максимальное кол-во Параграфов в отчете" указывается максимальное количество строк, которое должно отображаться в отчёте. Когда количество строк в отчёте будет превышено это предельное значение, то перед добавлением новых строк, вначале будет удалено соответствующее количество наиболее ранних, существующих, строк в отчёте.

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

Если установлен параметр "Логирование", то информация об архивировании будет сохранена в файл "log.txt", а информация о возникших ошибках сохранена в файл "error.txt".

В поле "Директорий для файлов логирования" можно указать директорий, в котором буду сохраняться файлы "log.txt" и "error.txt". Если это поле пустое, то эти файлы будут созданы в том же каталоге, из которого запускается приложение.

Кнопка "Добавить ассоциацию файла" позволяет добавить в систему ассоциацию файлов с расширением "bfs". При этом иконка файла с расширением "bfs" изменится, и появиться возможность открыть сохранённую конфигурацию архивирования простым двойным нажатием на файл.

Если была добавлена ассоциация файла, то кнопка изменит вид на "Удалить ассоциацию файла". Нажатие этой кнопки приведёт к тому, что ассоциация файла с расширением "bfs" будет отменена, иконка этого файла снова будет иметь стандартный вид неизвестного файла, и открыть этот файл двойным щелчком больше возможности не будет.

5. Ключи запуска архиватора.

5.1 Список ключей.

-nt   наименование задачи;

-i     объект(ы) архивирования, файл или директорий; возможен список через точку с запятой или пробел;

-o    директорий, в который будет произведено архивирование;

-oe  дополнительные директории, в которые будет произведено копирование созданных архивов; возможен список через точку с запятой или пробел;

-n    наименование архива; возможные префиксы в наименовании архива [(%n%|%ne%|%nb%|%d%)];

-nfd формат даты в наименовании архива; по умолчанию yyyyMMdd_HHmmss;

-cc   количество копий;

-cs   глубина вложения поддиректориев для архивирования (кроме 7z);

-at   тип архивирования (zip|7z|copy); по умолчанию zip;

-fd  фильтр директориев (кроме 7z);список через точку с запятой; для установки негативного фильтра в начале списка установить восклицательный знак [!];

-ff   фильтр файлов (кроме 7z); список через точку с запятой; для установки негативного фильтра в начале списка установить восклицательный знак [!];

-fre регулярные выражения в фильтрах (кроме 7z)

-r    печать отчёта об архивировании в файл [полное имя файла]. В случае не указания полного имени файла, файл будет создан в директории с архивом под именем наименования архива;

-rt   способ создания файла архива [(add|a)|(rewrite|r)|(number|n)|(date|d)]; по умолчанию add;

-rfd формат даты в наименовании файла отчёта. По умолчанию yyyyMMddHHmmss.

5.2 Описание ключей.

-nt  представляет собой строку содержащую любые символы, в том числе и пробелы; устанавливает условное наименование задания архивирования.

-i     добавляет объекты (файлы или папки) которые требуется заархивировать. Представляет из себя путь или список путей, разделённых точкой с запятой или пробелом, к файлам или папкам, которые требуется заархивировать. Пути содержащие в названии пробелы требуется заключать в кавычки.

-o    директорий, в котором будут создаваться резервные архивы.

-oe  дополнительные директории, в которых будут созданы копии резервных архивов. Представляет из себя путь или список путей, разделённых точкой с запятой или пробелом, к папкам, в которых будут созданы копии резервных архивов. Пути содержащие в названии пробелы требуется заключать в кавычки.

-n    устанавливает шаблон наименования файла архива. В шаблоне архива можно использовать три префикса, позволяющих создавать множество однородных архивных файлов в одном каталоге, установленном ключом  «-o».  Префикс «%d%» в шаблоне наименования архива будет заменён текущей датой и временем в соответствии с форматом  даты-времени установленного ключом «-nfd». Если при архивировании наименование создаваемого файла будет совпадать с уже существующим ранее наименованием файла, то к наименованию создаваемого файла архива в конце будет добавлен префикс _%n%, где %n% это ближайший неиспользуемый порядковый номер файла относительно списка одноименных файлов. Префикс «%n%» в шаблоне наименования архива будет заменён ближайшим неиспользуемым порядковым номером файла относительно списка одноименных файлов. Например, если в каталоге при существующем шаблоне «aaa%n%xxx» существуют файлы «aaa1xxx.7z», «aaa2xxx.7z» и «aaa4xxx.7z», то следующий созданный файл будет «aaa3xxx.7z». Префикс «%nb%» в шаблоне наименования архива будет заменен на 1, при этом каскадно переименовав предыдущие файлы, увеличив значение на месте префикса на единицу.  Последний созданный архив с префиксом «%nb%» всегда будет первым.  Префикс «%ne%» в шаблоне наименования архива будет заменен на последний порядковый номер файла относительно списка одноименных файлов. Например, если в каталоге при существующем шаблоне «aaa%ne%xxx» существуют файлы «aaa1xxx.7z», «aaa2xxx.7z» и «aaa4xxx.7z», то следующий созданный файл будет «aaa5xxx.7z». В наименовании шаблона можно использовать только один префикс: «%d%», «%n%», «%nb%» или «%ne%». Если в наименовании шаблона не будет использован ни один из префиксов, то наименование шаблона будет считаться как «наименование_архива_%n%», в случае, если наименование вновь создаваемого архива будет совпадать с наименованием уже созданного ранее архива. Во избежание сбоя при создании списка файла, не рекомендуется в одном каталоге хранить несколько списков файлов создаваемых по разным шаблонам наименования архива.

-nfd устанавливает формат даты для формирования наименования файла архива с использованием в шаблоне префикса «%d%». Представляет из себя строку с комбинацией шаблонных символов и дополнительных символов. В качестве шаблонных символов используются: «yyyy» -год в четырехзначном формате, «yy» - год в двухзначном формате, «MM» -номер месяца в двухзначном формате, «dd» - день, в двухзначном формате, «HH» - часы в двухзначном формате от 0 до 23, «hh» - часы в двухзначном формате от 1 до 12, «mm» - минуты в двухзначном формате, «ss» -секунды в двухзначном формате. Между комбинацией шаблонных символов можно установить дополнительные символы, например: «yyyy.MM.dd_HH:mm:ss».

-cc   целое  число устанавливающее число копий создаваемых архивов. При превышении разрешённого количества копий вновь создаваемые файлы будут заменять самые старые архивы.

-cs    целое число указывающее, на какой уровень подкаталогов требуется произвести архивирование. Этот ключ никак не влияет на создание архива в формате 7Z.

-at     определяет какой тип резервного архивирования будет произведен. «zip» будет создан файл архива в формате ZIP. «7z» будет создан файл архива в формате 7Z. В случае установки «copy» вместо архивного файла будет создана резервная копия указанного архива или директория.

-fd    устанавливает список фильтров через точку с запятой, позволяющих указать  какие конкретные директории из всех существующих требуется заархивировать, или не заархивировать, если в начале списка установлен восклицательный знак «!». В фильтрах, для указания диапазона наименований возможно установить специальные знаки: * - определяющий любые символы, и ? – определяющий один любой символ. Так же, если установлен ключ «-fre», то в качестве шаблона возможно использование регулярных выражений. Этот ключ никак не влияет на создание архива в формате 7Z.

-ff    устанавливает список фильтров через точку с запятой, позволяющих указать какие конкретно файлы из всех существующих требуется добавить в архив, или не отправить, если в начале списка установлен восклицательный знак «!». В фильтрах, для указания диапазона наименований возможно установить специальные знаки: * - определяющий любые символы, и ? – определяющий один любой символ. Так же, если установлен ключ «-fre», то в качестве шаблона возможно использование регулярных выражений. Этот ключ никак не влияет на создание архива в формате 7Z.

-r    устанавливает полное наименование файла, в котором будет сохранен отчет об архивировании текущего задания архивирования. В случае если указано только наименование файла, без пути к нему, файл будет создан в каталоге, куда производиться резервное архивирование.

-rt    устанавливает, каким образом будет формироваться файл отчета об архивировании текущего задания архивирования. «add» или «a» – новые данные отчета будут до записываться в созданный файл отчета. «rewrite» или «r «– новые данные будут перезаписывать существующие данные отчета. «number» или «n» – при создании очередного отчета будет создаваться новый файл, с порядковым номером файла в окончании наименовании файла отчета, если создается уже не первый отчет об архивировании. «date» или «d» – при создании файла отчета к наименованию файла добавляется текущая дата и время, в соответствии с установленным форматом ключом «-rfd». Если при формировании файла отчета наименование будет совпадать с уже существующим файлом, то в конце файла будет добавлен префикс в виде порядкового номера очередного созданного файла отчета.

-rfd     устанавливает формат даты добавляемый в наименование отчета при установленном параметре date или d ключа «–rt». Установка формата аналогична установке ключа «–nfd».

5.3 Описание дополнительных параметров запуска архиватора.

Указав при запуске приложение в качестве параметра запуска наименование файла, архиватор сразу же добавит сохраненное в указанном файле задание на выполнение задания. Если перед параметром наименованием файла установить параметр «open», то сохраненное в файле задние будет открыто в виде графического окна задания архивирования.

Для минимального задания архивирования требуется установить три ключа:
BackupFriend - i (список файлов или директориев) - o (директорий назначения) -n (шаблон наименования архива).

После запуска приложения с указанными ключами, сразу начнется архивирование с учетом указанных параметров в ключах. Если перед ключами установить параметр «open», то вместо архивирования откроется окно задания архивирования с установленными параметрами в соответствии с указанными параметрами в ключах.

6. Панель кнопок быстрого открытия заданий архивирования.

В левой части главного окна приложения расположено поле с кнопками быстрого открытия заданий архивирования. При первом запуске приложения это поле пустое. Далее, по мере создания или открытия заданий архивирования, на панели будут появляться кнопки, позволяющие сразу же открыть окно с конфигурацией задания архивирования. Количество созданных кнопок будет зависеть от параметра «Кол-во кнопок быстрой загрузки» в окне настройки приложения. Если количество кнопок в панели превысит указанное в настройках количество кнопок, то при создании очередной кнопки, которая появиться сверху стека кнопок, исчезнет последняя кнопка,  расположенная внизу стека кнопок.

Наименование кнопки представляет собой полное наименование файла, в котором находиться сохраненная конфигурация задания архивирования. Путем нажатия кнопки «Сменить наименование кнопок быстрой загрузки», или выбрав одноименный пункт меню, возможно изменить наименование кнопок на наименование задачи установленное в параметре ключа «-nt», или, что тоже самое, установленное в окне конфигурации задания.

7. Поле отчета.

В поле отчета отображается информация о начале и об окончании задания архивирования, а также информация об ошибках, возникших в процессе исполнения задания архивирования. При добавлении очередного задания в стек заданий архивирования, в отчете появляется информация в виде «Добавлено задание заархивировать "Архив".», и когда дойдет очередь до этого задания, то задания архивирования будет запущен, а в отчете появиться информация о начале архивирования в формате: «’текущая дата и время’: Начато архивирование "Архив".» Если в процессе архивирования возникли ошибки, то информация обо всех ошибках будет отображена в отчете и подсвечена красным шрифтом. После окончания архивирования, если архивирование закончилось, то появиться информация о создании архива. После полного окончания выполнения задания архивирования в отчете появиться информация в виде: «’текущая дата и время’: Закончено архивирование "Архив", время архивирования: ’промежуток времени прошедший с момента начала архивирования’». В соответствии с этой информацией можно узнать сколько времени занимает выполнение того или иного задания.

В процессе архивирования отчет может быть довольно объемный. Для того чтобы легче было определить какие ошибки возникли во время архивирования, используя кнопки перехода по ошибкам, или одноименные пункты меню, возможно передвигаться от ошибки к ошибке.

Для очистки поля отчета можно воспользоваться кнопкой «Очистка отчета», или одноименным пунктом меню.

Размер поля отчета можно изменять за счет изменения размера панели кнопок быстрого открытия заданий архивирования. Для этого следует навести курсор на границу между панелью кнопок быстрого открытия заданий архивирования и полем отчета до изменения курсор в виде двунаправленной стрелки. После этого, перетягивая левой кнопкой мыши границу влево или вправо, можно изменять размер поля отчета и панели кнопок быстрого открытия задания.

8. Окно конфигурации задания архивирования.

8.1 Панель управления

Вверху окна конфигурации задания архивирования расположена панель управления. На панелт управления расположены следующие кнопки:

«Новое задание» очищает текущее задание и подготавливает окно к установке параметров нового задания архивирования.

 «Загрузить задание» открывает диалоговое окно для выбора файла с расширением «*.bfs», и устанавливает параметры текущего окна в соответствии с сохраненными в файле параметрами архивирования.

 «Сохранить задание» сохраняет текущие параметры архивирования в открытый файл. Если при нажатии «Сохранить задание» файл открыт не был, то появиться диалоговое окно для сохранения параметров задания архивирования в файл.

«Сохранить задание как» открывает диалоговое окно для сохранения параметров задания архивирования в файл.

 «Архивировать задание» добавляет текущее задание в стек заданий архивации.

8.2 Наименование задания архивирования.

Окно заданий архивирования может содержать несколько заданий.  В этом случае каждое задание имеет свое уникальное имя, а количество заданий можно увидеть слева от наименования текущего выбранного задания. Выбрав из списка одно из заданий, значения параметров окна изменятся в соответствии с параметрами выбранного задания архивирования. Чтобы отредактировать наименование текущего задания нужно нажать кнопку , после чего появится окно для редактирования наименования задания.

Для того чтобы добавить к текущим заданиям еще одно задание архивирования нужно нажать кнопку , при этом появиться окно для ввода наименования задания, а параметры окна будут сброшены для установки новых параметров задания архивирования.

Для удаления текущего выбранного задания следует нажать кнопку .

8.3. Установка параметров окна задания архивирования.

Для настройки параметров задания архивирования используются три вкладки: «Локация», «Наименование», «Фильтр», «Дополнительно». Практически все параметры, расположенные на этих вкладках, можно настроить с использованием ключей при запуске приложения из командной строки.

8.4 Вкладка «Локация».

На вкладке «Локация» устанавливаются источники архивирования (ключ -i), в виде списка.

Нажав кнопку откроется окно для выбора директория. Воспользовавшись этим окном можно добавить в список источников архивирования нужную папку.

Кнопка  открывает окно для выбора файла, и позволяет добавить в список нужный файл.
С помощью кнопки  можно удалить из списка любой источник.
Воспользовавшись кнопками  и  можно изменить позицию источника архивирования в списке, источник можно передвинуть вверх или вниз по списку.

Кнопка  позволяет изменить выбранный в списке источник архивирования. Если выбран источник директорий, то откроется окно выбора директория, если выбран файл, то окно выбора файла.

На вкладке «Локация» так же устанавливается директорий назначения (ключ -o) в который будет производиться архивирования. Путь к директорию можно как ввести вручную в поле ввода, так и выбрать папку из окна выбора директориев  нажав кнопку .

На вкладке «Локация» расположено поле-список для добавления директориев, где будут создаваться копии созданных архивов (ключ -oe). Управлять списком можно с помощью кнопок аналогичных кнопкам управления списком источников архивирования, за исключением отсутствия кнопки выбора файла, так как в этом списке должны находиться только пути к папкам.

8.5 Вкладка «Наименование».

На вкладке «Наименования» устанавливается шаблон для формирования наименования создаваемого архивного файла. Правила установки шаблона руководствуются установке ключа «-n», описанного в пункте «5.2 Описание ключей».

Кроме это устанавливается количество копий, которое будет создано до того, как произойдет циклическое обновление файлов, т.е. после создание нового файла наиболее поздний файл будет удален (ключ -cc)

В поле находящемся под количеством копий, устанавливается формат даты, используемый при формировании имени архива, если в шаблоне наименования архива используется префикс «%d%» (ключ -nfd). Правила установки формата даты  указаны в пункте «5.2 Описание ключей» при описании соответствующего ключа. Ниже под полем указаны подсказки по возможным префиксам, используемым в шаблоне наименования архива.

8.6 Вкладка «Фильтр».

На вкладке фильтр устанавливаются фильтры для директориев и файлов попадающих под архивирование. Эти фильтры не работает при создании архива типа «7z». Управление списками фильтров производится с помощью кнопок аналогично управлению списками «Источника архивирования» и «Дополнительных директориев назначения». Отличие состоит в том, что кнопка открывает окно с текстовым полем ввода фильтра, куда можно вручную ввести фильтр со специальными знаками описанными в пункте «3.2 Описание ключей» для ключей «-fd» и «-ff».

 
Соответственно кнопка открывает тоже окно с текстовым полем ввода фильтра, но уже со строкой выбранного фильтра, который можно отредактировать.

Над списками есть возможность выбора: «Вкл.» и «Искл.». «Вкл.» означает, что в архив  попадут только те папки и файлы, которые попали под установленные фильтр. Соответственно «Искл.» означает, что в архив попадут только те файлы, которые под установленные фильтры не попали. Это аналогично тому, если в параметрах ключа «-ff» и -«fd» перед строкой фильтра установить восклицательный знак [!].

8.7 Вкладка «Дополнительно».

На вкладке дополнительно  находятся дополнительные параметры, влияющие на процесс архивирования.

«Тип архива» позволяет выбрать, какой архив будет создан (ключ -at):  zip, 7z или будет произведено копирование без архивации.

«Глубина архивирования» устанавливает значение, на какой уровень подкаталогов будет произведено архивирование (ключ -cs). Это значение не работает при создании архива типа «7z».

При установке параметра «Регулярные выражения в фильтрах», при установке фильтров для папок и файлов в качестве шаблонов можно использовать регулярные выражения. Если этот параметр не  установлен, то в шаблоне можно использовать только спецсимвол «*», что означает любое количество любых символов, и «?», что означает любой символ (ключ -fre). Этот параметр не работает при создании архива типа «7z».

При установке параметра «Сохранение отчета об архивировании в файл», появляются дополнительные параметры,  позволяющие настроить файл, в котором будет сохраняться отчет об архивировании. Во первых появляется поле, в которое надо установить наименование файла для отчета (ключ -r) . Если будет установлено полное наименование файла, вместе с полным путем в нему, то файл будет создан по указанному пути. Если будет указано только наименование файла, то файл будет создан в каталоге, в котором создается архив.

Далее есть возможность выбрать, каким образом будет создаваться файл отчета (ключ -rt), будет ли отчет до записываться в конец файл, после предыдущего отчета, или отчет будет каждый раз перезаписываться, или же будет создаваться для отчета отдельный файл. Причем, наименование файла отчета, каждый новый отчет может дополняться в конце наименования порядковым номером отчета, либо датой. Формат дополняемой даты (ключ -rfd) можно изменить в текстовом поле, которое появиться после того, как будет выбран этот параметр.

Ссылка на приложение Архиватор "Друг"