xref: /netbsd-src/usr.bin/utoppya/utoppya.1 (revision b7b7574d3bf8eeb51a1fa3977b59142ec6434a55)
1.\" $NetBSD: utoppya.1,v 1.5 2014/03/18 18:20:45 riastradh Exp $
2.\"
3.\" Copyright (c) 2006 The NetBSD Foundation, Inc.
4.\" All rights reserved.
5.\"
6.\" This code is derived from software contributed to The NetBSD Foundation
7.\" by Steve C. Woodford.
8.\"
9.\" Redistribution and use in source and binary forms, with or without
10.\" modification, are permitted provided that the following conditions
11.\" are met:
12.\" 1. Redistributions of source code must retain the above copyright
13.\"    notice, this list of conditions and the following disclaimer.
14.\" 2. Redistributions in binary form must reproduce the above copyright
15.\"    notice, this list of conditions and the following disclaimer in the
16.\"    documentation and/or other materials provided with the distribution.
17.\"
18.\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
19.\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
20.\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
21.\" PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
22.\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
23.\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
24.\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
25.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
26.\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
27.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
28.\" POSSIBILITY OF SUCH DAMAGE.
29.\"
30.Dd April 3, 2006
31.Dt UTOPPYA 1
32.Os
33.Sh NAME
34.Nm utoppya
35.Nd Topfield TF5000PVR file manipulation program
36.Sh SYNOPSIS
37.Nm
38.Op Fl f Ar device
39.Ar command ...
40.Sh DESCRIPTION
41.Nm
42is the userland interface to the
43.Xr utoppy 4
44device driver.
45.Pp
46The options are as follows:
47.Bl -tag -width Ds
48.It Fl f
49Communicate with
50.Ar device
51instead of the default
52.Pa /dev/utoppy0 .
53.El
54.Pp
55Using the services of the
56.Xr utoppy 4
57driver,
58.Nm
59can perform the following operations, specified by the
60.Ar command
61operand:
62.Bl -tag -width Ds
63.It Cm df
64Display disk size and free space
65.It Cm ls Op Ar directory
66List the files in the specified
67.Ar directory .
68Default is the Toppy's root directory.
69.It Cm mkdir Ao Ar directory Ac
70Make the specified
71.Ar directory .
72You must supply the full pathname to
73.Ar directory .
74.It Cm rm Ao Ar pathname Ac
75Delete the file or directory specified by
76.Ar pathname .
77.It Cm rename Ao Ar source Ac Ao Ar target Ac
78Rename the file or directory specified by the
79.Ar source
80operand to the destination file or directory specified by the
81.Ar target
82operand.
83.It Cm get Oo Fl prt Oc Ao Ar toppyfile Ac Oo Ar localfile Oc
84Copy
85.Ar toppyfile
86from the Toppy to
87.Ar localfile
88on the local filesystem.
89If
90.Ar localfile
91is omitted, the file will be copied into the current directory and will be
92named using the last component of the
93.Ar toppyfile
94operand.
95If
96.Ar localfile
97is
98.Sq - ,
99then
100.Ar toppyfile
101will be copied to the standard output.
102.Pp
103The following options are available for the
104.Nm get
105command:
106.Bl -tag -width Ds
107.It Fl p
108Display a progress bar.
109.It Fl r
110This option is useful if you wish to resume a previously interrupted
111.Nm get
112command.
113Instead of restarting from the beginning of the file, the transfer will
114resume where it left off.
115.It Fl t
116Enable
117.Ql Turbo
118mode.
119This instructs the Toppy to drop everything and concentrate on transferring
120the file as quickly as possible.
121You will be able to watch live TV, but all other functions, including
122changing channel via the remote control, will be inoperative.
123.El
124.It Cm put Oo Fl prt Oc Ao Ar localfile Ac Ao Ar toppyfile Ac
125Copy
126.Ar localfile
127on the local filesystem to
128.Ar toppyfile
129on the Toppy.
130If
131.Ar toppyfile
132specifies a directory on the Toppy, the last component of the
133.Ar localfile
134operand will be appended to the
135.Ar toppyfile
136operand.
137.Pp
138The options described for the
139.Nm get
140command (above) also apply to the
141.Nm put
142command.
143.El
144.Sh FILES
145.Pa /dev/utoppy0
146The default Topfield TF5000PVR instance.
147.Sh SEE ALSO
148.Xr usb 4 ,
149.Xr utoppy 4
150.Sh HISTORY
151The
152.Nm
153command first appeared in
154.Nx 4.0
155and was inspired by
156.Ql ftpd-topfield
157written by Steve Bennett
158.Aq msteveb at ozemail.com.au
159and
160.Ql puppy
161written by Peter Urbanec
162.Aq toppy at urbanec.net .
163.Sh AUTHORS
164.An Steve C. Woodford Aq Mt scw@netbsd.org
165