]> git.sesse.net Git - kdenlive/commitdiff
Fix issue 0000420: Please add manpages for kdenlive and kdenlive_render (http://www...
authorMads Bondo Dydensborg <mads@dydensborg.dk>
Sat, 6 Dec 2008 21:32:33 +0000 (21:32 +0000)
committerMads Bondo Dydensborg <mads@dydensborg.dk>
Sat, 6 Dec 2008 21:32:33 +0000 (21:32 +0000)
jb: I have tried to extend cmake as appropiate, and it works in my end, but if I have done something wrong, then please revert.

svn path=/branches/KDE4/; revision=2757

CMakeLists.txt
man/CMakeLists.txt [new file with mode: 0644]
man/kdenlive.1 [new file with mode: 0644]
man/kdenlive_render.1 [new file with mode: 0644]

index 78ac3e406ba4e78c254dbffa23e70203a6c42f28..6f9f1894aa6db4d8962f02a8e52f02d41afbe0e0 100644 (file)
@@ -34,6 +34,6 @@ add_subdirectory(export )
 add_subdirectory(icons )
 add_subdirectory(data )  
 add_subdirectory(po)
-
+add_subdirectory(man)
 
 
diff --git a/man/CMakeLists.txt b/man/CMakeLists.txt
new file mode 100644 (file)
index 0000000..84840a5
--- /dev/null
@@ -0,0 +1 @@
+install(FILES kdenlive.1 kdenlive_render.1 DESTINATION ${MAN_INSTALL_DIR}/man1 )
diff --git a/man/kdenlive.1 b/man/kdenlive.1
new file mode 100644 (file)
index 0000000..d1817ca
--- /dev/null
@@ -0,0 +1,149 @@
+.\" This file was generated by kdemangen.pl
+.TH KDENLIVE 1 "Nov 2008" "K Desktop Environment" "An open source video editor."
+.SH NAME
+kdenlive \- An open source non-linear video editor.
+.SH SYNOPSIS
+kdenlive [Qt\-options] [KDE\-options] [options] [file]
+.SH DESCRIPTION
+Kdenlive is an open source non-linear video editor which supports a
+large number of formats for editing, including DV, AVCHD (experimental support) and HDV. Kdenlive relies on several other open source projects, such as FFmpeg and MLT video framework.
+.SH OPTIONS
+.SS
+.SS Arguments:
+.TP
+.B file
+Document to open
+.SS Options:
+.TP
+.B  \-\-mlt\-path  <path>
+Set the path for MLT environnement
+.SS
+.SS Generic options:
+.TP
+.B  \-\-help
+Show help about options
+.TP
+.B  \-\-help\-qt
+Show Qt specific options
+.TP
+.B  \-\-help\-kde
+Show KDE specific options
+.TP
+.B  \-\-help\-all
+Show all options
+.TP
+.B  \-\-author
+Show author information
+.TP
+.B \-v,  \-\-version
+Show version information
+.TP
+.B  \-\-license
+Show license information
+.TP
+.B  \-\-
+End of options
+.SS
+.SS KDE options:
+.TP
+.B  \-\-caption  <caption>
+Use 'caption' as name in the titlebar
+.TP
+.B  \-\-icon  <icon>
+Use 'icon' as the application icon
+.TP
+.B  \-\-config  <filename>
+Use alternative configuration file
+.TP
+.B  \-\-nocrashhandler
+Disable crash handler, to get core dumps
+.TP
+.B  \-\-waitforwm
+Waits for a WM_NET compatible windowmanager
+.TP
+.B  \-\-style  <style>
+sets the application GUI style
+.TP
+.B  \-\-geometry  <geometry>
+sets the client geometry of the main widget - see man X for the argument format
+.SS
+.SS Qt options:
+.TP
+.B  \-\-display  <displayname>
+Use the X-server display 'displayname'
+.TP
+.B  \-\-session  <sessionId>
+Restore the application for the given 'sessionId'
+.TP
+.B  \-\-cmap
+Causes the application to install a private color
+map on an 8-bit display
+.TP
+.B  \-\-ncols  <count>
+Limits the number of colors allocated in the color
+cube on an 8-bit display, if the application is
+using the QApplication::ManyColor color
+specification
+.TP
+.B  \-\-nograb
+tells Qt to never grab the mouse or the keyboard
+.TP
+.B  \-\-dograb
+running under a debugger can cause an implicit
+-nograb, use -dograb to override
+.TP
+.B  \-\-sync
+switches to synchronous mode for debugging
+.TP
+.B \-\-fn,  \-\-font  <fontname>
+defines the application font
+.TP
+.B \-\-bg,  \-\-background  <color>
+sets the default background color and an
+application palette (light and dark shades are
+calculated)
+.TP
+.B \-\-fg,  \-\-foreground  <color>
+sets the default foreground color
+.TP
+.B \-\-btn,  \-\-button  <color>
+sets the default button color
+.TP
+.B  \-\-name  <name>
+sets the application name
+.TP
+.B  \-\-title  <title>
+sets the application title (caption)
+.TP
+.B  \-\-visual  TrueColor
+forces the application to use a TrueColor visual on
+an 8-bit display
+.TP
+.B  \-\-inputstyle  <inputstyle>
+sets XIM (X Input Method) input style. Possible
+values are onthespot, overthespot, offthespot and
+root
+.TP
+.B  \-\-im  <XIM server>
+set XIM server
+.TP
+.B  \-\-noxim
+disable XIM
+.TP
+.B  \-\-reverse
+mirrors the whole layout of widgets
+.TP
+.B  \-\-stylesheet
+<file.qss>   applies the Qt stylesheet to the application widgets
+.SS
+
+.SH SEE ALSO
+Please see the homepage at
+.BR http://www.kdenlive.org/
+.br
+.SH AUTHORS
+.nf
+Jean-Baptiste Mardelle <jb@kdenlive.org>
+.br
+Marco Gittler <g.marco@freenet.de>
+.br
diff --git a/man/kdenlive_render.1 b/man/kdenlive_render.1
new file mode 100644 (file)
index 0000000..cb18edc
--- /dev/null
@@ -0,0 +1,55 @@
+.\" This file was generated by kdemangen.pl
+.TH KDENLIVE_RENDER 1 "Dec 2008" "K Desktop Environment" "Render program for Kdenlive."
+.SH NAME
+kdenlive_render
+\- Render program for Kdenlive.
+.SH SYNOPSIS
+kdenlive_render [-erase] [in=pos] [out=pos] [render] [profile] [rendermodule] [player] [src] [dest] [[arg1] [arg2] ...]
+.SH DESCRIPTION
+Render program for Kdenlive. Renders kdenlive project detached from Kdenlive, while providing feedback through kuiserver. This program is not meant to be called directly by users, but is called from Kdenlive, when a rendering process is started.
+.SH OPTIONS
+.SS
+.SS Options:
+.TP
+.B  \-erase
+If present, src file will be erased after rendering
+.TP
+.B  in=pos
+Start rendering at frame pos
+.TP
+.B  out=pos
+End rendering at frame pos
+.TP
+.B  render
+Path to MLT inigo render program
+.TP
+.B  profile
+The MLT video profile
+.TP
+.B  rendermodule
+The MLT consumer used for rendering, usually it is avformat
+.TP
+.B player
+Path to video player to play when rendering is over, use '-' to disable playing
+.TP
+.B  src
+Source file - usually MLT Westley playlist
+.TP
+.B  dest
+Destination file
+.TP
+.B  args
+Space separated libavformat arguments
+.SS 
+
+.SH SEE ALSO
+Please see the homepage at 
+.BR http://www.kdenlive.org/
+.br
+.SH AUTHORS
+.nf
+Jean-Baptiste Mardelle <jb@kdenlive.org>
+.br
+Marco Gittler <g.marco@freenet.de>
+.br
+