154 lines
5.1 KiB
HTML
154 lines
5.1 KiB
HTML
|
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
|
|
<HTML><HEAD><TITLE>Man page of VSTP</TITLE>
|
|
</HEAD><BODY>
|
|
<H1>VSTP</H1>
|
|
Section: BrlAPI User's Manual (1)<BR>Updated: 2002-07-15<BR><A HREF="#index">Index</A>
|
|
<A HREF="/cgi-bin/man/man2html">Return to Main Contents</A><HR>
|
|
|
|
<A NAME="lbAB"> </A>
|
|
<H2>NAME</H2>
|
|
|
|
vstpg, vstpp - VisioBraille file transferring
|
|
<A NAME="lbAC"> </A>
|
|
<H2>SYNOPSIS</H2>
|
|
|
|
vstpg [-ifbnd] [-s <I>socketport</I>] [-k <I>keyname</I>] [-o <I>configname</I>] file ...
|
|
<A NAME="lbAD"> </A>
|
|
<H2>DESCRIPTION</H2>
|
|
|
|
<I>vstpg</I> (resp. <I>vstpp</I>) gets (resp. puts) files from (resp. onto)
|
|
a VisioBraille terminal.
|
|
<P>
|
|
For communicating with the terminal, you must launch brltty with the BrlNet
|
|
driver, and telling BrlNet to use the VisioBraille driver.
|
|
<P>
|
|
Before putting on the terminal, file names are truncated to 8 characters
|
|
without any extension.
|
|
<P>
|
|
Before getting from terminal, leading path and trailing extensions are removed,
|
|
but put back for local filename.
|
|
<P>
|
|
<A NAME="lbAE"> </A>
|
|
<H2>COMMAND-LINE OPTIONS</H2>
|
|
|
|
<P>
|
|
<DL COMPACT>
|
|
<DT id="1"><B>-i</B><DD>
|
|
ask for confirmation of transfer, for each file (on the terminal)
|
|
<DT id="2"><B>-f</B><DD>
|
|
don't ask for such a confirmation (default)
|
|
<DT id="3"><B>-b</B><DD>
|
|
if they exists, recursively rename the old files with an added .x suffix,
|
|
just like logrotate does
|
|
<DT id="4"><B>-n</B><DD>
|
|
do not keep such backup file (default)
|
|
<DT id="5"><B>-s</B> <I>socketport</I><DD>
|
|
use socketport as the port number instead of default for connecting to BrlNet
|
|
<DT id="6"><B>-k</B> <I>filename</I><DD>
|
|
use filename as key path instead of default for reading BrlNet's
|
|
authentication key
|
|
<DT id="7"><B>-d</B><DD>
|
|
use current directory rather than the download directory
|
|
(see <I>vbs_dir</I> below)
|
|
<DT id="8"><B>-o</B> <I>filename</I><DD>
|
|
also read filename as config file
|
|
<P>
|
|
</DL>
|
|
<A NAME="lbAF"> </A>
|
|
<H2>CONFIG FILE</H2>
|
|
|
|
<P>
|
|
<I>vstpg</I> and <I>vstpp</I> read a configuration file <B>$HOME/.vstprc</B> which
|
|
contains keywords or equalities, one per line (what follows a # is
|
|
ignored).
|
|
<P>
|
|
You can ask them to also read any other file thanks to the <B>-o</B> option.
|
|
<P>
|
|
Here are keywords:
|
|
<P>
|
|
<DL COMPACT>
|
|
<DT id="9"><B>backup</B><DD>
|
|
make <B>-b</B> option the default
|
|
<P>
|
|
<DT id="10"><B>nobackup</B><DD>
|
|
make <B>-f</B> option the default
|
|
<P>
|
|
<DT id="11">and equalities:<DD>
|
|
<P>
|
|
<DT id="12"><B>keyname</B> = <I>filename</I><DD>
|
|
use this file instead of default, to find BrlNet's authentication key
|
|
<P>
|
|
<DT id="13"><B>socketport</B> = <I>port</I><DD>
|
|
use this port number, instead of default, to connect to BrlNet
|
|
<P>
|
|
<DT id="14"><B>vbs_ext</B> = <I>.ext</I><DD>
|
|
use .ext as an extension for downloaded files (.vis by default)
|
|
this is overridden on command line if an extension is provided in the file name
|
|
<P>
|
|
<DT id="15"><B>vbs_dir</B> = <I>path</I><DD>
|
|
use path instead of current directory for putting files, except when
|
|
using the <B>-d</B> option, or if the filename begins with '.'
|
|
<P>
|
|
</DL>
|
|
<A NAME="lbAG"> </A>
|
|
<H2>RETURNED VALUE</H2>
|
|
|
|
<P>
|
|
<TABLE>
|
|
<TR VALIGN=top><TD><B>1</B></TD><TD>syntax error on command line<BR></TD></TR>
|
|
<TR VALIGN=top><TD><B>2</B></TD><TD>connection with BrlNet error<BR></TD></TR>
|
|
<TR VALIGN=top><TD><B>3</B></TD><TD>Unix file error<BR></TD></TR>
|
|
<TR VALIGN=top><TD><B>4</B></TD><TD>Protocol error<BR></TD></TR>
|
|
<TR VALIGN=top><TD><B>16</B></TD><TD>interrupted by user<BR></TD></TR>
|
|
</TABLE>
|
|
|
|
<P>
|
|
<A NAME="lbAH"> </A>
|
|
<H2>SHELL EXPANSIONS</H2>
|
|
|
|
Beware of special chars: * and . are often expanded by your shell, hence
|
|
<I>vstpp *</I> will probably do what you want, putting every file existing in
|
|
the current directory onto the terminal, but <I>vstpg *</I> may not do what you
|
|
want: it will only get every file which already exist in the current
|
|
directory, skipping those you just created on your terminal !
|
|
If you want to get every file which exist in the terminal, you
|
|
should use <I>vstpg '*'</I> or something similar (please read your shell manual).
|
|
<P>
|
|
The same warning applies to other special chars, such as $, ~, &,... which
|
|
should be protected by surrounding arguments by quotes (') or by using single
|
|
backslashes (\) just before them (please read your shell manual).
|
|
<P>
|
|
<A NAME="lbAI"> </A>
|
|
<H2>BUGS</H2>
|
|
|
|
The one we could find has been corrected :)
|
|
<P>
|
|
<A NAME="lbAJ"> </A>
|
|
<H2>AUTHOR</H2>
|
|
|
|
Samuel Thibault <<A HREF="mailto:samuel.thibault@ens-lyon.org">samuel.thibault@ens-lyon.org</A>>
|
|
and Sebastien Hinderer <<A HREF="mailto:sebastien.hinderer@ens-lyon.fr">sebastien.hinderer@ens-lyon.fr</A>>
|
|
<P>
|
|
|
|
<HR>
|
|
<A NAME="index"> </A><H2>Index</H2>
|
|
<DL>
|
|
<DT id="16"><A HREF="#lbAB">NAME</A><DD>
|
|
<DT id="17"><A HREF="#lbAC">SYNOPSIS</A><DD>
|
|
<DT id="18"><A HREF="#lbAD">DESCRIPTION</A><DD>
|
|
<DT id="19"><A HREF="#lbAE">COMMAND-LINE OPTIONS</A><DD>
|
|
<DT id="20"><A HREF="#lbAF">CONFIG FILE</A><DD>
|
|
<DT id="21"><A HREF="#lbAG">RETURNED VALUE</A><DD>
|
|
<DT id="22"><A HREF="#lbAH">SHELL EXPANSIONS</A><DD>
|
|
<DT id="23"><A HREF="#lbAI">BUGS</A><DD>
|
|
<DT id="24"><A HREF="#lbAJ">AUTHOR</A><DD>
|
|
</DL>
|
|
<HR>
|
|
This document was created by
|
|
<A HREF="/cgi-bin/man/man2html">man2html</A>,
|
|
using the manual pages.<BR>
|
|
Time: 00:05:29 GMT, March 31, 2021
|
|
</BODY>
|
|
</HTML>
|