summaryrefslogtreecommitdiffstats
path: root/doc/man
diff options
context:
space:
mode:
Diffstat (limited to 'doc/man')
-rw-r--r--doc/man/CMakeLists.txt5
-rw-r--r--doc/man/kpicosim.151
2 files changed, 56 insertions, 0 deletions
diff --git a/doc/man/CMakeLists.txt b/doc/man/CMakeLists.txt
new file mode 100644
index 0000000..8512250
--- /dev/null
+++ b/doc/man/CMakeLists.txt
@@ -0,0 +1,5 @@
+INSTALL(
+ FILES ${PROJECT_NAME}.1
+ DESTINATION ${MAN_INSTALL_DIR}/man1
+ COMPONENT doc
+)
diff --git a/doc/man/kpicosim.1 b/doc/man/kpicosim.1
new file mode 100644
index 0000000..0348ae8
--- /dev/null
+++ b/doc/man/kpicosim.1
@@ -0,0 +1,51 @@
+.\" Hey, EMACS: -*- nroff -*-
+.\" First parameter, NAME, should be all caps
+.\" Second parameter, SECTION, should be 1-8, maybe w/ subsection
+.\" other parameters are allowed: see man(7), man(1)
+.TH KPICOSIM 1 "November 12, 2005"
+.\" Please adjust this date whenever revising the manpage.
+.\"
+.\" Some roff macros, for reference:
+.\" .nh disable hyphenation
+.\" .hy enable hyphenation
+.\" .ad l left justify
+.\" .ad b justify to both left and right margins
+.\" .nf disable filling
+.\" .fi enable filling
+.\" .br insert line break
+.\" .sp <n> insert n+1 empty lines
+.\" for manpage-specific macros, see man(7)
+.SH NAME
+kpicosim \- IDE and simulator for the Xilinx PicoBlaze-3
+.SH SYNOPSIS
+.B kpicosim
+.SH DESCRIPTION
+.B kpicosim
+is a development environment for the Xilinx
+PicoBlaze-3 soft-core processor for the Trinity Desktop (Linux).
+The environment has an editor with syntax highlighting, compiler,
+simulator and export functions to VHDL, HEX and MEM files.
+.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.
+.\"\fBkpicosim\fP is a program that...
+.SH OPTIONS
+Currently, there are no options. Perhaps, one day there will be
+some more.
+.SP 1
+These programs follow the usual GNU command line syntax, with long
+options starting with two dashes (`-').
+A summary of options is included below.
+For a complete description, see the Info files.
+.TP
+.B \-h, \-\-help
+Show summary of options.
+.TP
+.B \-v, \-\-version
+Show version of program.
+.SH AUTHOR
+kpicosim was written by Mark Six <m6@xs4all.nl>.
+.PP
+This manual page was written by Adrian Knoth <adi@thur.de>
+for the Debian project (but may be used by others).