Skip to content

Commit 2bf6611

Browse files
nbourdaunbourdau
committed
Update manpages with shortcuts (closes: #663869)
1 parent 26b6b40 commit 2bf6611

5 files changed

Lines changed: 133 additions & 50 deletions

File tree

‎debian/fakenect-record.1‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
.TH FAKENECT-RECORD 1 2012-01-29 "libfreenect" "libfreenect manual"
1+
.TH FAKENECT-RECORD 1 2012-05-21 OpenKinect "libfreenect manual"
22
.SH NAME
33
fakenect-record - program to save dumps from kinect to file
44
.SH SYNOPSIS

‎debian/fakenect.1‎

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
.TH FAKENECT 1 2012-01-29 "libfreenect" "libfreenect manual"
1+
.TH FAKENECT 1 2012-05-21 OpenKinect "libfreenect manual"
22
.SH NAME
33
fakenect - Run a program by faking the Kinect
44
.SH SYNOPSIS
@@ -13,6 +13,8 @@ fakenect - Run a program by faking the Kinect
1313
the data contained in the folder \fIdatabase\fP. These data should have been
1414
recorded using \fIfakenect-record\fP(1).
1515
.SH "SEE ALSO"
16-
.BR fakenect-record (1)
16+
.BR fakenect-record (1),
17+
.BR freenect-glpcview (1),
18+
.BR freenect-cppview (1)
1719

1820

‎debian/freenect-cppview.1‎

Lines changed: 53 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,57 @@
1-
.TH FREENECT-GLVIEW "1" "11 December 2010" "Freenect camera test" "User Commands"
1+
.TH FREENECT-CPPVIEW 1 2012-05-21 OpenKinect "libfreenect manual"
22
.SH NAME
33
freenect-cppview \- manual page for freenect camera test
4-
.SH SYNOPSYS
5-
.B freenect-glview
4+
.SH SYNOPSIS
5+
.SY freenect-cppview
66
.SH DESCRIPTION
7-
This is a simple demo program from the OpenKinect project. To be able to use it, you need to connect a
8-
kinect camera device to the USB port of your system.
9-
.PP
10-
This program requires OpenGL (Glut) to be installed.
11-
.PP
7+
.LP
8+
This is a simple demo program that illustrates the use of the C++
9+
libfreenect library. It also provide a simple way to test the communication
10+
with the freenect device.
11+
.SS Shortcuts
12+
.TP
13+
.B ESC
14+
Exit the program
15+
.TP
16+
.B Key W
17+
Increase tilt
18+
.TP
19+
.B Key S
20+
Reset tilt to 0
21+
.TP
22+
.B Key X
23+
Decrease tilt
24+
.TP
25+
.B Key E
26+
Set tilt to 10
27+
.TP
28+
.B Key C
29+
Set tilt to \-10
30+
.TP
31+
.B Key F
32+
Change video format
33+
.TP
34+
.B Key 1
35+
Change LED color to still green
36+
.TP
37+
.B Key 2
38+
Change LED color to still red
39+
.TP
40+
.B Key 3
41+
Change LED color to still yellow
42+
.TP
43+
.B Key 4
44+
Change LED color to blinking green
45+
.TP
46+
.B Key 5
47+
Change LED color to blinking green
48+
.TP
49+
.B Key 6
50+
Change LED color to blinking red and yellow
51+
.TP
52+
.B Key 0
53+
Switch off the LED
1254
.SH "SEE ALSO"
13-
The full documentation for
14-
.B Freenect
15-
is available in the libfreenect doc directory,
16-
see
17-
.B /usr/share/doc/libfreenect.
18-
.SH AUTHORS
19-
Arne Bernin (arne@alamut.de)
20-
55+
.BR fakenect (1),
56+
.BR freenect-glview (1),
57+
.BR freenect-glpcview (1)

‎debian/freenect-glpclview.1‎

Lines changed: 22 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,25 @@
1-
.TH FREENECT-GLVIEW "1" "11 December 2010" "Freenect camera test" "User Commands"
1+
.TH FREENECT-GLPCVIEW 1 2012-05-21 OpenKinect "libfreenect manual"
22
.SH NAME
3-
freenect-glpclview \- manual page for freenect camera test
4-
.SH SYNOPSYS
5-
.B freenect-glview
3+
freenect-glpcview \- manual page for freenect camera test
64
.SH DESCRIPTION
7-
This is a simple demo program from the OpenKinect project. To be able to use it, you need to connect a kinect camera device to the USB port of your system.
8-
.PP
9-
This program requires OpenGL (Glut) to be installed.
10-
.PP
5+
.LP
6+
This is a simple demo program that illustrates the use of the C synchronous
7+
libfreenect library. It also provides a simple way to test the communication
8+
with the freenect device.
9+
.SS Shortcuts
10+
.TP
11+
.B ESC
12+
Exit the program
13+
.TP
14+
.B Key W
15+
Increase zoom
16+
.TP
17+
.B Key S
18+
Decrease zoom
19+
.TP
20+
.B Key C
21+
Switch on/off the texture image
1122
.SH "SEE ALSO"
12-
The full documentation for
13-
.B Freenect
14-
is available in the libfreenect doc directory,
15-
see
16-
.B /usr/share/doc/libfreenect.
17-
.SH AUTHORS
18-
Arne Bernin (arne@alamut.de)
19-
23+
.BR fakenect (1),
24+
.BR freenect-glview (1),
25+
.BR freenect-cppview (1)

‎debian/freenect-glview.1‎

Lines changed: 53 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,57 @@
1-
.TH FREENECT-GLVIEW "1" "11 December 2010" "Freenect camera test" "User Commands"
1+
.TH FREENECT-GLVIEW 1 2012-05-21 OpenKinect "libfreenect manual"
22
.SH NAME
33
freenect-glview \- manual page for freenect camera test
4-
.SH SYNOPSYS
5-
.B freenect-glview
4+
.SH SYNOPSIS
5+
.SY freenect-glview
6+
.OP \fIdevice_index\fP
67
.SH DESCRIPTION
7-
This is a simple demo program from the OpenKinect project. To be able to use it, you need to connect a kinect camera device to the USB port of your system.
8-
.PP
9-
This program requires OpenGL (Glut) to be installed.
10-
.PP
8+
.LP
9+
This is a simple demo program that illustrates the use of the libfreenect
10+
library. It also provide a simple way to test the communication with the
11+
freenect device.
12+
.SS Shortcuts
13+
.TP
14+
.B ESC
15+
Exit the program
16+
.TP
17+
.B Key W
18+
Increase tilt
19+
.TP
20+
.B Key S
21+
Reset tilt to 0
22+
.TP
23+
.B Key X
24+
Decrease tilt
25+
.TP
26+
.B Key F
27+
Change video format
28+
.TP
29+
.B Key 1
30+
Change LED color to still green
31+
.TP
32+
.B Key 2
33+
Change LED color to still red
34+
.TP
35+
.B Key 3
36+
Change LED color to still yellow
37+
.TP
38+
.B Key 4
39+
Change LED color to blinking green
40+
.TP
41+
.B Key 5
42+
Change LED color to blinking green
43+
.TP
44+
.B Key 6
45+
Change LED color to blinking red and yellow
46+
.TP
47+
.B Key 0
48+
Switch off the LED
49+
.SH OPTIONS
50+
.TP
51+
.B \fIdevice_index\fP
52+
Specify the index of device that should be used. This option is useful when
53+
several devices are connected.
1154
.SH "SEE ALSO"
12-
The full documentation for
13-
.B Freenect
14-
is available in the libfreenect doc directory,
15-
see
16-
.B /usr/share/doc/libfreenect.
17-
.SH AUTHORS
18-
Arne Bernin (arne@alamut.de)
19-
55+
.BR fakenect (1),
56+
.BR freenect-glpcview (1),
57+
.BR freenect-cppview (1)

0 commit comments

Comments
 (0)