.\"                                      Hey, EMACS: -*- nroff -*-
.\" First parameter, NAME, should be all caps
.\" Second parameter, SECTION, should be 1-8, maybe w/ subsection
.\" other parameters are allowed: see man(7), man(1)
.TH OWX 1 "October 26, 2011"
.\" Please adjust this date whenever revising the manpage.
.\"
.\" Some roff macros, for reference:
.\" .nh        disable hyphenation
.\" .hy        enable hyphenation
.\" .ad l      left justify
.\" .ad b      justify to both left and right margins
.\" .nf        disable filling
.\" .fi        enable filling
.\" .br        insert line break
.\" .sp <n>    insert n+1 empty lines
.\" for manpage-specific macros, see man(7)
.SH NAME
owx \- utility to program Wouxun dual-band handheld radios
.SH SYNOPSIS
.B owx-check [ -v | -h ] [ -f ] [ -p <port> ] [ -t <timeout> ]
.br
.B owx-get [ -v | -h ] [ -f ] [ -p <port> ] [ -t <timeout> ] -o <path>
.br
.B owx-put [ -v | -h ] [ -f ] [ -p <port> ] [ -t <timeout> ] -i <path> -r <path>
.br
.B owx-export [ -v | -h ] -i <bin path> -o <csv path>
.br
.B owx-import [ -v | -h ] -i <csv path> -o <bin path>
.SH DESCRIPTION
This manual page documents briefly the
.B owx
commands.
.PP
.\" TeX users may be more comfortable with the \fB<whatever>\fP and
.\" \fI<whatever>\fP escape sequences to invode bold face and italics,
.\" respectively.
\fBowx\fP is a set of commands that will allow you to fetch and update
configuration on your Wouxun handheld radio. It is made of multiple
commands.
.SH COMMON OPTIONS
These options are common to all commands.
.TP
.B \-h
Show summary of options.
.TP
.B \-v
Show version of program.
.TP
.B \-c <command>
Invoke owx-<command>. Makes sense only if called directly as
\fBowx\fP.
.SH OPTIONS FOR check, get AND put
.TP
.B \-f
Force operation even if your radio identifies different from a KG669V.
Use this option with extreme caution - it is very possible that your
radio will be rendered unusable after you use this. It was NEVER
tested with any radio different from mentoined above.
.TP
.B \-p <port>
Use port <port>, defaults to /dev/ttyUSB0. Of course you must have
appropriate read and write permissions for this device.
.TP
.B \-t <timeout>
Specify the receive timeout for communication with radio. If you
disable it (by setting to 0) and the communication fails, the program
will hang forever. You probably don't need to change the default value
(5 seconds).
.SH USAGE
.TP
.B owx-check
This program just checks for the connection and identification string. It 
can be used to check that your cable and port works.
.TP
.B owx-get
This program downloads memory map from radio to binary file.

Options:

-o <path>: binary file to write to

.TP
.B owx-put

This program uploads memory map from binary file to radio.

Options:

-i <path>: binary file to read from
.br
-r <path>: reference file

Option -r is not mandatory, but recommended. You can specify original, 
unchanged file (exactly as downloaded using owx-get) and this will speed 
up memory uploading, as owx will compare input file to this reference 
file and upload only changed memory pages. When using this option, be 
sure that nothing has changed in the radio (even the currently selected 
memory channel) between downloading reference file and using it for 
upload. This is important as some variables that cross the page 
boundaries (if there are any in the memory map) could be corrupted 
by this.

Example:

owx-get -o file.bin
.br
cp file.bin backup.bin
.br
owx-export -i file.bin -o wouxun.csv
.br
oocalc wouxun.csv
.br
owx-import -i wouxun.csv -o file.bin
.br
owx-put -i file.bin -r backup.bin

Please do yourself a favour and double-check that you upload the correct 
file. If you try to upload incorrect or corrupted file, your radio will 
power down and fail to power up. owx will refuse to upload any file with 
incorrect size, but this is the only safety check.

.TP
.B owx-export

This program exports channel data from binary file to CSV file. This file 
can be later edited using your favourite spreadsheet editor or even text 
editor.

Options:

-i <path>: binary file to read from
.br
-o <path>: csv file to write to

.TP
.B owx-import

This program reads the specified, possibly edited by you CSV file, and 
patches existing binary file with this updated data. The file is now 
prepared to be uploaded with owx-put.

Options:

-i <path>: csv file to read from

-o <path>: binary file to write to (must already exist)
.SH SEE ALSO
.BR chirp (1),
the README file.
.SH AUTHOR
owx was written by SP5GOF (Adam Wysocki).
.PP
This manual page was written by Antoine Beaupré <anarcat@debian.org>,
for the Debian project (and may be used by others).