Справка по использованию LWUpChecker

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

На сайте необходимо на любую страницу, или в любой файл добавить текст с версией программы. Текст представляет собой строку с номером последней версии программы, заключенный в определённые маркеры. Версия программы должна состоять из целых чисел (от одного до четырёх), разделённых точками. Перед версией должен стоять маркер начала версии: "versionstart_". После версии должен стоять маркер конца версии: "_versionend". Пример текста: "versionstart_1.2.22_versionend". К этой странице будет обращаться LWUpChecker, чтобы узнать номер последней версии программы. Можно сделать на своём сайте текстовый файл, содержащий только этот текст - в этом случае трафик, расходуемый LWUpChecker при проверке версии, будет минимальным. Можно добавить в любой HTML-файл на сайте комментарий или hidden-поле, содержащее данный текст. В этом случае посетители, заходящие на сайт, не будут видеть маркеры и версию программы, но для LWUpChecker версия будет доступна.

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

Параметры командной строки, принимаемые LWUpChecker, следующие:

  • curver - текущая версия обновляемой программы. Также как и на сайте, версия программы должна состоять из целых чисел (от одного до четырёх), разделённых точками. Эту версию LWUpChecker будет сравнивать с той версией, которая указана на сайте.
  • prog - название обновляемой программы. Название программы отображается в сообщениях, отображаемых пользователю. Например, если указать "SuperProg", LWUpChecker будет выдавать сообщение о наличии новой версии с текстом "Доступна новая версия SuperProg. Перейти на страницу загрузки?".
  • site - полный адрес (URL) страницы или файла на сайте, к которому будет обращаться LWUpChecker для получения последней версии программы. Это адрес той страницы, на которой указана версия с маркерами. Например, для программы TakeBreak адрес страницы с номером версии следующий: "http://life-warrior.org/distrib/version_takebreak.txt".
  • goto - полный адрес (URL) страницы на сайте, с которой можно загрузить программу. Это страница, которую LWUpChecker откроет в браузере, если пользователь согласится на предложение перейти на страницу загрузки новой версии программы.
  • nupmsg - идентификатор режима отображения сообщений в случае отсутствия доступных обновлений программы. Это должно быть целое число от 0 до 2. 0 означает поведение по умолчанию. При этом в текущей версии LWUpChecker сообщение не отображается, но в других версиях такое поведение может измениться. 1 означает "не отображать сообщение". В этом случае LWUpChecker при отсутствии доступных обновлений не будет отображать сообщение. 2 означает "отображать сообщение". Если передано это значение параметра, при отсутствии доступных обновлений LWUpChecker будет выдавать сообщение "Установлена последняя версия [программы]", где [программа] - это название программы, переданное в параметре "prog".

Например, в программе TakeBreak проверка обновлений производится следующим образом. В случае, если в настройках программы стоит галочка "Проверять обновления при запуске", при каждом запуске TakeBreak также запускает LWUpChecker, передавая ему строку параметров "curver=1.1.15 prog=TakeBreak site=http://life-warrior.org/distrib/version_takebreak.txt goto=http://life-warrior.org/programs/takebreak/download nupmsg=0". При этом, если обновлений не будет обнаружено, LWUpChecker завершает свою работу незаметно для пользователя, не выдавая никаких сообщений. Также в окне настроек программы есть кнопки "Настройки сети" и "Проверить обновления сейчас". При нажатии на первую кнопку запускается LWUpChecker без параметров - при этом отображается окно, в котором можно отредактировать сетевые настройки LWUpChecker (в основном сводящиеся к указанию прокси-сервера). При нажатии на вторую кнопку, для немедленной проверки обновлений, запускается LWUpChecker с теми же параметрами, что и при запуске программы, но с параметром "nupmsg=2". В этом случае LWUpChecker выдаст сообщение как при наличии доступных обновлений, так и при их отсутствии. В результате при отсутствии обновлений у пользователя не возникнет впечатления, что программа не запустилась.