xref: /netbsd-src/usr.bin/utoppya/utoppya.1 (revision 4175efc23450e7678d44db30c2642826d5e61fb9)
1.\" $NetBSD: utoppya.1,v 1.7 2015/06/21 12:05:11 wiz Exp $
2.\"
3.\" Copyright (c) 2006,2015 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 DVB recorder 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
43Topfield TF5000PVR range of DVB recorders (nicknamed `Toppy')
44which uses the
45.Xr utoppy 4
46device driver.
47.Pp
48The options are as follows:
49.Bl -tag -width Ds
50.It Fl f
51Communicate with
52.Ar device
53instead of the default
54.Pa /dev/utoppy0 .
55.El
56.Pp
57Using the services of the
58.Xr utoppy 4
59driver,
60.Nm
61can perform the following operations, specified by the
62.Ar command
63operand:
64.Bl -tag -width Ds
65.It Cm df
66Display disk size and free space
67.It Cm ls Op Ar directory
68List the files in the specified
69.Ar directory .
70Default is the Toppy's root directory.
71.It Cm mkdir Ao Ar directory Ac
72Make the specified
73.Ar directory .
74You must supply the full pathname to
75.Ar directory .
76.It Cm rm Ao Ar pathname Ac
77Delete the file or directory specified by
78.Ar pathname .
79.It Cm rename Ao Ar source Ac Ao Ar target Ac
80Rename the file or directory specified by the
81.Ar source
82operand to the destination file or directory specified by the
83.Ar target
84operand.
85.It Cm get Oo Fl prt Oc Ao Ar toppyfile Ac Oo Ar localfile Oc
86Copy
87.Ar toppyfile
88from the Toppy to
89.Ar localfile
90on the local file system.
91If
92.Ar localfile
93is omitted, the file will be copied into the current directory and will be
94named using the last component of the
95.Ar toppyfile
96operand.
97If
98.Ar localfile
99is
100.Sq - ,
101then
102.Ar toppyfile
103will be copied to the standard output.
104.Pp
105The following options are available for the
106.Nm get
107command:
108.Bl -tag -width Ds
109.It Fl p
110Display a progress bar.
111.It Fl r
112This option is useful if you wish to resume a previously interrupted
113.Nm get
114command.
115Instead of restarting from the beginning of the file, the transfer will
116resume where it left off.
117.It Fl t
118Enable
119.Ql Turbo
120mode.
121This instructs the Toppy to drop everything and concentrate on transferring
122the file as quickly as possible.
123You will be able to watch live TV, but all other functions, including
124changing channel via the remote control, will be inoperative.
125.El
126.It Cm put Oo Fl prt Oc Ao Ar localfile Ac Ao Ar toppyfile Ac
127Copy
128.Ar localfile
129on the local filesystem to
130.Ar toppyfile
131on the Toppy.
132If
133.Ar toppyfile
134specifies a directory on the Toppy, the last component of the
135.Ar localfile
136operand will be appended to the
137.Ar toppyfile
138operand.
139.Pp
140The options described for the
141.Nm get
142command (above) also apply to the
143.Nm put
144command.
145.El
146.Sh FILES
147.Pa /dev/utoppy0
148The default Topfield TF5000PVR instance.
149.Sh SEE ALSO
150.Xr usb 4 ,
151.Xr utoppy 4
152.Sh HISTORY
153The
154.Nm
155command first appeared in
156.Nx 4.0
157and was inspired by
158.Ql ftpd-topfield
159written by Steve Bennett
160.Aq msteveb at ozemail.com.au
161and
162.Ql puppy
163written by Peter Urbanec
164.Aq toppy at urbanec.net .
165.Sh AUTHORS
166.An Steve C. Woodford Aq Mt scw@netbsd.org
167