Go to main content

man pages section 1: User Commands

Exit Print View

Updated: Thursday, June 13, 2019
 
 

vstp (1)

Name

vstp - VisioBraille file transferring

Synopsis

vstpg [-ifbnd] [-s socketport] [-k keyname] [-o configname] file ...

Description

VSTP(1)                      BrlAPI User's Manual                      VSTP(1)



NAME
       vstpg, vstpp - VisioBraille file transferring

SYNOPSIS
       vstpg [-ifbnd] [-s socketport] [-k keyname] [-o configname] file ...

DESCRIPTION
       vstpg  (resp. vstpp) gets (resp. puts) files from (resp. onto) a Visio-
       Braille terminal.

       For communicating with the terminal, you must launch  brltty  with  the
       BrlNet driver, and telling BrlNet to use the VisioBraille driver.

       Before  putting  on the terminal, file names are truncated to 8 charac-
       ters without any extension.

       Before getting from terminal, leading path and trailing extensions  are
       removed, but put back for local filename.


COMMAND-LINE OPTIONS
       -i     ask  for  confirmation of transfer, for each file (on the termi-
              nal)

       -f     don't ask for such a confirmation (default)

       -b     if they exists, recursively rename the old files with  an  added
              .x suffix, just like logrotate does

       -n     do not keep such backup file (default)

       -s socketport
              use  socketport  as  the port number instead of default for con-
              necting to BrlNet

       -k filename
              use filename as key path instead of default for reading BrlNet's
              authentication key

       -d     use  current  directory  rather than the download directory (see
              vbs_dir below)

       -o filename
              also read filename as config file


CONFIG FILE
       vstpg and vstpp read a configuration file $HOME/.vstprc which  contains
       keywords or equalities, one per line (what follows a # is ignored).

       You can ask them to also read any other file thanks to the -o option.

       Here are keywords:


       backup make -b option the default


       nobackup
              make -f option the default


       and equalities:


       keyname = filename
              use  this  file instead of default, to find BrlNet's authentica-
              tion key


       socketport = port
              use this port number, instead of default, to connect to BrlNet


       vbs_ext = .ext
              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


       vbs_dir = path
              use path instead of current directory for putting files,  except
              when using the -d option, or if the filename begins with '.'


RETURNED VALUE
       1    syntax error on command line
       2    connection with BrlNet error
       3    Unix file error
       4    Protocol error
       16   interrupted by user


SHELL EXPANSIONS
       Beware  of  special  chars:  *  and . are often expanded by your shell,
       hence vstpp * will probably do what you want, putting every file exist-
       ing  in the current directory onto the terminal, but vstpg * 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 vstpg '*' or something similar (please read your shell manual).

       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).


BUGS
       The one we could find has been corrected :)


AUTHOR
       Samuel Thibault <samuel.thibault@ens-lyon.org> and  Sebastien  Hinderer
       <sebastien.hinderer@ens-lyon.fr>



ATTRIBUTES
       See attributes(7) for descriptions of the following attributes:


       +---------------+------------------------------+
       |ATTRIBUTE TYPE |       ATTRIBUTE VALUE        |
       +---------------+------------------------------+
       |Availability   | library/accessibility/brltty |
       +---------------+------------------------------+
       |Stability      | Pass-through volatile        |
       +---------------+------------------------------+
NOTES
       This     software     was    built    from    source    available    at
       https://github.com/oracle/solaris-userland.   The  original   community
       source     was     downloaded     from     http://mielke.cc/brltty//ar-
       chive/brltty-5.4.tar.xz

       Further information about this software can be found on the open source
       community website at http://mielke.cc/brltty/.



BrlAPI                            2002-07-15                           VSTP(1)