summaryrefslogtreecommitdiffstats
path: root/doc/man/kate
diff options
context:
space:
mode:
Diffstat (limited to 'doc/man/kate')
-rw-r--r--doc/man/kate/CMakeLists.txt7
-rw-r--r--doc/man/kate/kate.183
-rw-r--r--doc/man/kate/kwrite.160
3 files changed, 150 insertions, 0 deletions
diff --git a/doc/man/kate/CMakeLists.txt b/doc/man/kate/CMakeLists.txt
new file mode 100644
index 000000000..65c83b94f
--- /dev/null
+++ b/doc/man/kate/CMakeLists.txt
@@ -0,0 +1,7 @@
+file( GLOB _man_files RELATIVE ${CMAKE_CURRENT_SOURCE_DIR} *.1 )
+
+install(
+ FILES ${_man_files}
+ DESTINATION ${MAN_INSTALL_DIR}/man1
+ COMPONENT doc
+)
diff --git a/doc/man/kate/kate.1 b/doc/man/kate/kate.1
new file mode 100644
index 000000000..e48268d6f
--- /dev/null
+++ b/doc/man/kate/kate.1
@@ -0,0 +1,83 @@
+.TH KATE 1 "May 2006"
+.SH NAME
+kate \- TDE Advanced Text Editor
+.SH SYNOPSIS
+.B kate
+.RI [ options ] [file(s)]
+.SH DESCRIPTION
+This manual page documents briefly the
+.B kate
+command.
+This manual page was written for the Debian distribution
+because the original program does not have a manual page.
+.PP
+.\" TeX users may be more comfortable with the \fB<whatever>\fP and
+.\" \fI<whatever>\fP escape sequences to invode bold face and italics,
+.\" respectively.
+\fBkate\fP is a powerful text editor for TDE. It allows multiple documents (MDI interface), syntax coloration for many languages, ...
+
+It is able to expand or collapse parts of code (C functions, ...), can handle complete projects, and includes a terminal emulator.
+
+Kate is primarily intended for developers but can be used by anyone. It will for example be very useful to edit configuration files for example.
+
+It can handle plugins to expand its capabilities (more languages support, vim/Emacs compatibility, ...)
+
+.SH OPTIONS
+These programs follow the usual GNU command line syntax, with long
+options starting with two dashes (`-').
+A summary of options is included below.
+.TP
+.B \-\-help
+Show summary of options.
+.TP
+.B \-\-help\-qt
+Show QT specific help (common for all QT apps).
+.TP
+.B \-\-help\-tde
+Show TDE specific help (common for all TDE apps).
+.TP
+.B \-\-help\-all
+Show the complete help.
+.TP
+.B \-\-author
+Show program author(s).
+.TP
+.B \-\-license
+Show program license.
+.TP
+.B \-v, \-\-version
+Show version of program.
+.TP
+.B \-s, \-\-start <name>
+Start Kate with a given session
+.TP
+.B \-u, \-\-use
+Use a already running kate instance (if possible)
+.TP
+.B \-p, \-\-pid <pid>
+Only try to reuse kate instance with this pid
+.TP
+.B \-e, \-\-encoding <name>
+Set encoding for the file to open
+.TP
+.B \-l, \-\-line <line>
+Navigate to this line
+.TP
+.B \-c, \-\-column <column>
+Navigate to this column
+.TP
+.B \-i, \-\-stdin
+Read the contents of stdin
+.TP
+.B file(s)
+is the file or the files to open
+
+.SH SEE ALSO
+.BR kwrite (1)
+.PP
+For more details, you should have a look at the TDE Help center, available
+from the T menu.
+.SH AUTHOR
+This manual page was written by Clement Stenac <[email protected]>, for Debian GNU/Linux, but may be used by others.
+.PP
+kate was written by the KDE project
diff --git a/doc/man/kate/kwrite.1 b/doc/man/kate/kwrite.1
new file mode 100644
index 000000000..f7d39f61d
--- /dev/null
+++ b/doc/man/kate/kwrite.1
@@ -0,0 +1,60 @@
+.TH KWRITE 1 "August, 25 2003"
+.SH NAME
+kwrite \- TDE text editor
+.SH SYNOPSIS
+.B kwrite
+.RI [ options ] [file]
+.SH DESCRIPTION
+This manual page documents briefly the
+.B kwrite
+command.
+This manual page was written for the Debian distribution
+because the original program does not have a manual page.
+.PP
+.\" TeX users may be more comfortable with the \fB<whatever>\fP and
+.\" \fI<whatever>\fP escape sequences to invode bold face and italics,
+.\" respectively.
+\fBkwrite\fP is a text editor for TDE, that is a light version of \fIkate\fP.
+It allows syntax coloration for many langages.
+
+It is able to expand or collapse parts of code (C functions, ...).
+
+.SH OPTIONS
+These programs follow the usual GNU command line syntax, with long
+options starting with two dashes (`-').
+A summary of options is included below.
+.TP
+.B \-\-help
+Show summary of options.
+.TP
+.B \-\-help\-qt
+Show QT specific help (common for all QT apps).
+.TP
+.B \-\-help\-tde
+Show TDE specific help (common for all TDE apps).
+.TP
+.B \-\-help\-all
+Show the complete help.
+.TP
+.B \-\-author
+Show program author(s).
+.TP
+.B \-\-license
+Show program license.
+.TP
+.B \-v, \-\-version
+Show version of program.
+
+.B file
+is the file to open
+
+.SH SEE ALSO
+.BR kate (1)
+.PP
+For more details, you should have a look at the TDE Help center, available
+from the T menu.
+.SH AUTHOR
+This manual page was written by Clement Stenac <[email protected]>,
+for the Debian GNU/Linux project (but may be used by others).
+.PP
+kwrite was written by the KDE project