Add manpages for fakenect and fakenect-record

Signed-off-by: Nicolas Bourdaud <nicolas.bourdaud@gmail.com>

Author: nbourdau

cmake_modules/SetupDirectories.cmake

@@ -10,6 +10,7 @@ MESSAGE (STATUS "${PROJECT_NAME} will be installed to ${CMAKE_INSTALL_PREFIX}")
 # Installation prefix for include files
 STRING (TOLOWER ${PROJECT_NAME} projectNameLower)
 SET (PROJECT_INCLUDE_INSTALL_DIR "include/${projectNameLower}")
+SET (PROJECT_MANPAGE_INSTALL_DIR "share/man")
 
 IF (PROJECT_PROC_64BIT)
  SET (LIB_SUFFIX "64" CACHE STRING "Suffix for library installation directory")

fakenect/CMakeLists.txt

@@ -24,3 +24,6 @@ CONFIGURE_FILE("fakenect.sh.in"
 install (PROGRAMS ${CMAKE_CURRENT_BINARY_DIR}/fakenect.sh
  DESTINATION bin
  RENAME fakenect)
+
+install(FILES fakenect.1 fakenect-record.1
+ DESTINATION ${PROJECT_MANPAGE_INSTALL_DIR}/man1)

fakenect/fakenect-record.1

@@ -0,0 +1,53 @@
+.TH FAKENECT-RECORD 1 2012-01-29 "libfreenect" "libfreenect manual"
+.SH NAME
+fakenect-record - program to save dumps from kinect to file 
+.SH SYNOPSIS
+.SY fakenect-record 
+.OP \-h
+.OP \-ffmpeg
+.OP \-ffmpeg-opts \fIoptions\fP
+.I outputdir
+.br
+.SH DESCRIPTION
+.LP
+\fBfakenect-record\fP dumps the output of the kinect in \fIoutputdir\fP
+folder. It saves the acceleration, depth, and rgb data as individual files
+with names in the form "TYPE-CURRENTIME-TIMESTAMP" where:
+.IP " *" 3 
+TYPE is either (a)ccel, (d)epth, or (r)gb
+.IP " *" 3 
+TIMESTAMP corresponds to the timestamp associated with the observation (or
+in the case of accel, the last timestamp seen)
+.IP " *" 3 
+CURRENTTIME corresponds to a floating point version of the time in seconds. 
+.LP
+The purpose of storing the current time is so that delays can
+be recreated exactly as they occurred. For RGB and DEPTH the dump is just
+the entirety of the data provided in PPM and PGM formats respectively (just
+a 1 line header above the raw dump). For ACCEL, the dump is the
+"freenect_raw_tilt_state". Only the front part of the file name is used,
+with the rest left undefined (extension, extra info, etc).
+.LP
+A file called INDEX.txt is also output with all of the filenames local to
+that directory to simplify the format (e.g., no need to read the directory
+structure).
+.LP
+Once started, the program will continue to acquire data from the kinect.
+When you want to stop it, hit Ctrl-C and the signal will be caught, runloop
+stopped, and everything will be stored cleanly.
+.SH OPTIONS
+.TP 
+.B \-ffmpeg
+If present, send the the video stream to ffmpeg
+.
+.TP
+.B \-ffmpeg-opts \fIoptions\fP
+When using ffmpeg, specify the options to be used with it. If unspecified,
+it will use the options "\-aspect 4:3 \-r 20 \-vcodec msmpeg4 \-b 30000k"
+.
+.TP
+.B \-h
+Display the command-line help
+.SH "SEE ALSO"
+.BR fakenect (1)
+

fakenect/fakenect.1

@@ -0,0 +1,18 @@
+.TH FAKENECT 1 2012-01-29 "libfreenect" "libfreenect manual"
+.SH NAME
+fakenect - Run a program by faking the Kinect
+.SH SYNOPSIS
+.SY fakenect 
+.I database
+.I application
+.I args
+.br
+.SH DESCRIPTION
+.LP
+\fBfakenect\fP runs \fIapplication\fP with the arguments \fIargs\fP using
+the data contained in the folder \fIdatabase\fP. These data should have been
+recorded using \fIfakenect-record\fP(1).
+.SH "SEE ALSO"
+.BR fakenect-record (1)
+
+