0.1. Кодировка самого файла конфигурации обязательно должна быть UTF-8 вне зависимости от варианта шлюза или операционной системы или используемой на компьютере кодировки. Просто должна быть UTF-8 всегда.
0.2. Национальные буквы в FRN. Оригинальные клиент и сервер используют только локальную ANSI-кодировку конкретного компьютера Windows. Поэтому пришлось обеспечить некоторую совместимость для UNIX/Linux , хотя даже это не всегда срабатывает. Есть параметр CharsetName (1.5) из секции [Auth] (1). Например, для русского языка в FRN используется кодировка WINDOWS-1251. Смотри также команду ansi (0.4.22).
0.3. Список доступных имен кодировок для вашего UNIX/Linux вы можете получить через системную команду "iconv -l".
0.4. Допустимые флаги и параметры (команды) командной строки:
0.4.0. Флаги командной строки: 0.4.0.1. Флаг -w <width>, --width <width> -- ширина шкалы при исполнении команд audiolevel (0.4.4), audiolevelgain (0.4.25) и serverlevel (0.4.38). 0.4.0.2. Флаг -p, --pidfile -- явно создавать PID-файл при запуске клиента на исполнение командами run (0.4.10) и debug (0.4.9) в соответствии с параметром PidFile (8.3) из секции [System] (8). PID-файл с корректным PID-значением необходим для исполнения команд stop (0.4.15) и reopenlog (0.4.16). 0.4.0.3. Флаг -u, --utf8 -- принудительно выводить протокол событий в кодировке UTF-8. Наиболее подходит для платформенно-независимого вывода протокола событий. 0.4.0.4. Флаг -a, --ansi [только MS Windows] -- принудительно выводить протокол событий в ANSI-кодировке для конкретно вашей MS Windows. Наиболее подходит для вывода протокола событий в файл. Смотри также команду ansi (0.4.22). 0.4.0.5. Флаг -o, --oem [только MS Windows] -- принудительно выводить протокол событий в OEM-кодировке для конкретно вашей MS Windows. Наиболее подходит для вывода протокола событий в консольное окно. 0.4.0.6. Флаг -r <c>, --deli <c> - [ревизия r7129+] - явно установить символ-разделитель полей для списков. Формат совпадает с параметром LogClientListDelimiter (8.13) в секции [System] (8). Не забывайте о возможной необходимости экранирования символа обратной дроби (\) в командных процессорах, например, -r\\t или '-r\t'.
0.4.1. Командный параметр help - получить список допустимых параметров (команд) командной строки клиента;
0.4.2. Командный параметр audio - получить список имен доступных звуковых устройств; эта команда может конфликтовать с ранее запущенной на исполнение копией клиента, в этом случае результат может быть некорректным; 0.4.2.1. Командный параметр inaudio - [ревизия 6702+] - получить список имен доступных входных (захват) звуковых устройств; 0.4.2.2. Командный параметр outaudio - [ревизия 6702+] - получить список имен доступных выходных (воспроизведение) звуковых устройств;
0.4.3. Командный параметр audioconfig - получить список имен звуковых устройств, доступных для FRN-шлюза, в формате файла конфигурации в кодировке UTF8, можно просто скопировать нужные строки и вставить в конфигурационный файл; предназначена в основном для прямой дозаписи списков звуковых устройтв в конфигурационный файл по команде FRNClientConsole audioconfig >> configfilename; эта команда может конфликтовать с ранее запущенной на исполнение копией шлюза, в этом случае результат может быть некорректным;
0.4.4. Командный параметр audiolevel [configfilename] - проверить работоспособность звуковой подсистемы на ввод звука в соответствии с настройками из секции [Audio] (2) конфигурационного файла, конкретного или по умолчанию. Информация выводится как абсолютное линейное значение уровня на входе детектора VOX: уровню 0 dB соответствует значение 32768, а значение 328 соответствует уровню -40dB и (ревизия r3636+) в виде линейной псевдошкалы уровня. Позволяет первично оценить уровень сигнала от радиостанции. Например, в момент приема без голоса уровень может быть около 500-1000, а в момент разговора с нормальной громкостью должен в пиках доходить до 25000-30000; если же уровень во время разговора всегда выше этих самых 25000-30000, то это перемодуляция по входу. Также может быть использована для относительно точной настройки самого VOX-детектора: например, если с закрытым шумодавом уровень колеблется от 0 до 100, а с открытым - от 500 и выше, то в качестве уровня срабатывания VOX можно поставить значение 250. Ревизия r3636+: необязательная опция -w, --width определяет ширину псевдошкалы, по умолчанию 66. Команда может конфликтовать с ранее запущенной на исполнение копией шлюза, в этом случае результат может быть некорректным. Команда не учитывает значение параметра параметра InGainK (2.33) из секции [Audio] (2). Смотри также команду audiolevelgain (0.4.25).
0.4.5. Командный параметр radio - получить список поддерживаемых клиентом типов интерфейсов взаимодействия с радиостанцией, включая список доступных имен проводов и допустимых направлений их использования;
0.4.6. Командный параметр checkrate audiodevicename - [ревизия r2781+] проверить допустимые драйвером частоты дискретизации на ввод и вывод для конкретного звукового устройства audiodevicename; следует учитывать, что перечень допустимых частот дискретизации для драйвера может отличаться от перечня частот собственно физического устройства, тогда ответственность за поддержку разницы в списках частот берет на себя сам драйвер, тут следует выбирать либо по качеству преобразования либо по нагрузке на процессор; имя устройства следует брать из результатов команд audio (0.4.2), inaudio (0.4.2.1) или outaudio (0.4.2.2); эта команда может конфликтовать с ранее запущенным на исполнение экземпляром клиента, в этом случае результат может быть некорректным;
0.4.7. Командный параметр checkrateconfig [configfilename] - [ревизия r2781+] проверить допустимые частоты дискретизации на ввод и вывод для звуковых устройств из конфигурационного файла, конкретного или по умолчанию; следует учитывать, что перечень допустимых частот дискретизации для драйвера может отличаться от перечня частот собственно физического устройства, тогда ответственность за поддержку разницы в списках частот берет на себя сам драйвер, тут следует выбирать либо по качеству преобразования либо по нагрузке на процессор; эта команда может конфликтовать с ранее запущенной на исполнение копией шлюза, в этом случае результат может быть некорректным;
0.4.8. Командный параметр checkinput:interfacetype:devicename[:inputwire] [configfilename] - проверить работоспособность входного интерфейса от радиостанции, см.также п.3.4 Формат описания линий управления; при этом будут выводится имена проводов, на которых присутствует активный входной сигнал; значения обязательного параметра interfacetype и необязательного inputwire следует брать из результатов команды radio(п.0.4.5); звуковая система на ввод звука должна быть настроена в конфигурационном файле, конкретном или по умолчанию; эта команда может конфликтовать с ранее запущенной на исполнение копией шлюза, в этом случае результат может быть некорректным; 0.4.8.1. Пример для последовательного порта: 0.4.8.1.1. - FreeBSD: checkinput:COM:/dev/cuau0 или checkinput:COM:/dev/cuaU0:CTS 0.4.8.1.2. - Linux: checkinput:COM:/dev/ttyS0 или checkinput:COM:/dev/ttyUSB0:DCD 0.4.8.1.3. - Windows: checkinput:COM:COM3 или checkinput:COM:COM8:DSR 0.4.8.2. Пример для голосового управления VOX (FreeBSD/Linux/Windows): checkinput:VOX:250 0.4.8.3. Пример для портов ввода-вывода SYSFS-GPIO (Linux-ARM): checkinput:GPIO:2:gpio2 0.4.8.4. Пример для портов ввода-вывода звуковой карты CM108/CM109/CM119 (UNIX/Linux): checkinput:CM108:/dev/hidraw0:VOLDN
0.4.9. Командный параметр debug [configfilename] - запустить клиент с записью протокола событий в стандартный вывод c использованием конфигурационного файла, конкретного или по умолчанию; равносильно запуску без параметров; PID-файл при необходимости может быть создан опцией -p, --pidfile (0.4.0.2).
0.4.10. Командный параметр run [configfilename] или nostdout [configfilename] - запустить клиент с записью протокола событий в файл из параметра LogFile (8.4) c использованием конфигурационного файла, конкретного или по умолчанию. PID-файл при необходимости может быть создан опцией -p, --pidfile (0.4.0.2).
0.4.11. Командный параметр daemon [configfilename] - [r2781+, только UNIX/Linux] - запустить клиент фоновым процессом (демоном) c использованием конфигурационного файла, явно указанного или по умолчанию; записью протокола событий будет выполняться в файл журнала - смотри параметр LogFile (8.4) из секции [System] (8); идентификатор фонового процесса будет сохранен в pid-файл - смотри также параметр PidFile (8.3) из секции [System] (8);
0.4.12. Командный параметр register [configfilename] - [r3342+] - зарегистрировать или перерегистрировать в оригинальной сети FRN данные учетной записи FRN из секции [Auth] (1) конфигурационного файла, явно указанного или по умолчанию; в процессе [пере]регистрации будут использоваться также настройки из секций [Manager] (4) и [Internet] (6); [корректно] работающий FRN System Manager должен будет выслать новый статический пароль на адрес е-почты из параметра EMailAddress (1.1.3) из секции [Auth] (1);
0.4.13. Командный параметр logfilename [configfilename] - [r3638+] - возвращает фактическое абсолютное имя журнала согласно настройкам из конфигурационного файла, явно указанного или по умолчанию; для использования в скриптах автоматизации; смотри также параметр LogFile (8.4) из секции [System] (8);
0.4.14. Командный параметр pidfilename [configfilename] - [r3638+, только UNIX/Linux] - возвращает фактическое абсолютное имя файла с номером фонового процесса (демона) по настройкам из конфигурационного файла, явно указанного или по умолчанию; для использования в скриптах автоматизации; смотри также параметр PidFile (8.3) из секции [System] (8);
0.4.15. Командный параметр stop [configfilename] - [r4630+, только UNIX/Linux] - остановить ранее запущенный фоновый процесс (демон) клиента; посылает SIGTERM-сигнал фоновому процессу с использованием PID фонового процесса из PID-файла; смотри также команду pidfilename (0.4.14) и параметр PidFile (8.3) из секции [System] (8);
0.4.16. Командный параметр reopenlog [configfilename] - [r5000+, только UNIX/Linux ] - переоткрыть файл журнала ранее запущенного фонового процесса (демона) клиента; до ревизии 7129 посылает сигнал SIGHUP к фоновому процессу (демону) с использованием PID этого фонового процесса из PID -файла; начиная с ревизии 7129+ посылает сигнал из параметра ReopenLogSignal (8.23) в секции [System] (8). Эта команда предназначена для использования совместно с системами вращения журналов вроде logrotate и подобными; смотри также команду pidfilename (0.4.14) и параметр PidFile (8.3) из секции [System ] (8) и опцию -p, --pidfile (0.4.0.2).
0.4.17. Командный параметр deletepidfile [configfilename] - [r5000+, только UNIX/Linux] - принудительно удаляет PID-файл; может понадобиться перед стартом клиента для удаления pid-файла, оставшегося после отключения источника питания; смотри также команду pidfilename (0.4.14) и параметр PidFile (8.3) из секции [System] (8);
0.4.18. Командный параметр setmanager address port [configfilename] - [r5102+] - записать в конфигурационный файл клиента, явно указанный или по умолчанию, новые адрес address и порт port для FRN-System-Manager; для применения новых значений требуется перезапуск клиента; для использования в скриптах автоматизации; см. также параметры ManagerAddress (4.5) и ManagerPort (4.5) из секции [Manager] (4);
0.4.19. Командный параметр setauthpass<PasSwORd> [configfilename] - [r5102+] - записать в конфигурационный файл клиента, явно указанный или по умолчанию, новый статический пароль <PasSwORd>; для применения нового пароля требуется перезапуск клиента; для использования в скриптах автоматизации; смотри также параметр Password (1.1.6) из секции [Auth] (1);
0.4.20. Командный параметр dynpass [configfilename] - [r5102+] - явно запросить новый динамический пароль у FRN-System-Manager; новый динамический пароль будет сохранен для дальнейшего использования; смотри также параметр DynamicPasswordFileName (8.16) из секции [System] (8); выполнять команду следует в момент, когда AlterFRN клиент отключен от сервера;
0.4.21. Командный параметр down [configfilename] - [r5246+] - принудительно отключает выходные линии PTT (3.1), LIGHT (3.3), STATIC (3.11) и CONNECT (3.18) из секции [Radio] (3) в неактивное состояние, например, после принудительного снятия клиента с исполнения, чтобы отключить ненужное излучение из радиостанции.
0.4.22. Командный параметр ansi - [только MS Windows, r6367+] - показать имя текущей ANSI кодировки символов для вашей MS Windows с вашей локализацией/языком. Именно эта кодировка есть ANSI-кодировка символов для вашего языка в оригинальных FRN клиенте и сервере. Смотри также параметр CharsetName (1.5) из секции [Auth] (1).
0.4.23. Командный параметр charsets - [только MS Windows, r6367+] - показать список доступных имен кодировок символов для вашей MS Windows.
0.4.24. Командный параметр audiospeedconfig [configfilename] - [ревизия r6442+] - измерить время инициализации, реинициализации звуковой подсистемы и время старта и остановка звуковых потоков на ввод(захват) и вывод(воспроизведение) для звуковых устройств из конфигурационного файла. Полезна для выяснения причин возможных задержек при вводе или выводе звука. На разных комбинациях аппаратных и/или программных платформ время старта звуковой подсистемы может сильно различаться. Время старта до 100 миллисекунд я считаю хорошим вариантом, до 200 - приемлемым, а если задержка на старт более 200 миллисекунд, то это уже может приводить, например, к потерям начала фразы при быстром темпе разговора. При критичности слишком медленных значений следует задуматься о смене аппаратной и/или программной платформ. Измеренное время останова ввода(захвата) или вывода(воспроизведения) также может содержать в себе время обработки текущего блока звуковой карты (40,80,120,160,200мс) - смотри также параметры InFactor (2.4) и OutFactor (2.12).
0.4.25. Командный параметр audiolevelgain [configfilename] - [ревизия r6453+] - полностью соответствует команде audiolevel (0.4.4), но учитывает значение параметра InGainK (2.33) из секции [Audio] (2).
0.4.26. Командный параметр public "text of public message" [configfilename] - [ревизия r6512+] - послать публичное сообщение в текущую сеть(комнату). Требуется активированный командный канал.
0.4.27. Командный параметр private clientid "text of private message" [configfilename] - [ревизия r6512+] - послать частное сообщение клиенту clientid в текущей сети(комнате). Требуется активированный командный канал.
0.4.28. Командный параметр logtext "text to log" [configfilename] - [ревизия r6562+] - записать произвольный текст в журнал клиента AlterFRN. Требуется активированный командный канал.
0.4.29. Командный параметр uptime [configfilename] - [ревизия r6562+] - показывает время работы запущенного ранее AlterFRN-клиента. Требуется активированный командный канал.
0.4.30. Командный параметр dpid [configfilename] - [ревизия r6562+] - показывает идентификатор процесса (PID) запущенного ранее AlterFRN-клиента. Требуется активированный командный канал.
0.4.31. Командные параметры ( carrieron | carrieroff ) [configfilename] - [ревизия r6830+] - программное управление несущей, детектируемой на входной линии COS (3.2) для типа CTRL (3.4.1.6) через активированный командный канал.
0.4.32. Командные параметры ( pttenable | pttdisable | cosenable | cosdisable | radioenable | radiodisable ) [configfilename] - [ревизия r6830+] - управление работой выходной линии PTT (3.1) или входной линии COS (3.2) или обоими сразу без перезапуска клиента. Требуется активированный командный канал. Смотри также параметры PttEnable (3.19) и CosEnable (3.20) из секции Radio (3).
0.4.33. Командный параметр list [configfilename] - [ревизия r6830+] - выдает через активированный командный канал список клиентов в сети(комнате), в которую клиент подключен в текущий момент, если настройки протокола допускают передачу списка для подключенного сервера. Смотри также параметр ProtoListFormat (5.15).
0.4.34. Командный параметр network [configfilename] - [ревизия r6989+] - выдает имя текущей сети(комнаты), в которую предположительно клиент подключен в настоящее время. Требуется активированный командный канал.
0.4.35. Командный параметр networks [configfilename] - [ревизия r6989+] - выдает список сетей(комнат) из последнего успешного подключения к серверу. Требуется активированный командный канал.
0.4.36. Командные параметры ( pttstatus | cosstatus | radiostatus ) [configfilename] - [ревизия r6990+] - получить текущие режимы работы выходной линии PTT (3.1) или входной линии COS (3.2) или обоих сразу без перезапуска клиента. Требуется активированный командный канал. Смотри также параметры PttEnable (3.19) и CosEnable (3.20) из секции Radio (3).
0.4.37. Командный параметр dreopenlog [configfilename] - [ревизия r6990+] - послать через активированный командный канал к демону сигнал о необходимости переоткрыть журнал; команда может использоваться совместно с системами вращения журналов подобно команде reopenlog (0.4.16).
0.4.38. Командный параметр serverlevel [configfilename] - [ревизия r7070+] - показать уровень входного сигнала от радиостанции с учетом всех входных звуковых настроек, включая входные ФВЧ(HPF) и АРУ(AGC). Именно так сигнал с радиостанции будет посылаться через сервер к другим корреспондентам при рабочем подключении.
0.4.39. Командный параметр muteclientid [configfilename] - заглушить клиента clientid. Требуется активированный командный канал и права администратора.
0.4.40. Командный параметр mutetemptimeclientid [configfilename] - заглушить клиента clientid на время time в секундах. Сервер автоматически снимет заглушение по прошествии указанного времени. Требуется активированный командный канал и права администратора. Поддерживается только при подключении к AlterFRN-серверу.
0.4.41. Командный параметр unmuteclientid [configfilename] - снять заглушение с клиента clientid. Требуется активированный командный канал и права администратора.
0.4.42. Командный параметр blockclientid [configfilename] - заблокировать клиента clientid. Требуется активированный командный канал и права администратора.
0.4.43. Командный параметр blocktemptimeclientid [configfilename] - заблокировать клиента clientid на время time в секундах. Сервер автоматически снимет блокировку по прошествии указанного времени. Требуется активированный командный канал и права администратора. Поддерживается только при подключении к AlterFRN-серверу.
0.4.44. Командный параметр unblockclientid [configfilename] - снять блокировку с клиента clientid. Требуется активированный командный канал и права администратора.
0.4.45. Командный параметр moveclientidnetto [configfilename] - переместить клиента clientid в сеть(комнату) netto. Требуется активированный командный канал и права администратора в текущей сети(комнате) и сети(комнате) netto.
0.4.46. Командный параметр movetemptimeclientidnetto [configfilename] - переместить клиента clientid в сеть(комнату) netto на время time в секундах. Сервер автоматически вернет клиента обратно по истечении указанного времени, если возможно. Требуется активированный командный канал и права администратора в текущей сети(комнате) и сети(комнате) netto. Поддерживается только при подключении к AlterFRN-серверу.
