github.com/wfjm.w11
1
0
Fork 0
mirror of https://github.com/wfjm/w11.git synced 2026-02-21 07:05:36 +00:00
Code Issues Releases Wiki Activity

minor editorial changes on man pages

Browse Source
This commit is contained in:
Walter F.J. Mueller
2017-01-15 16:00:22 +01:00
parent 38470145a0
commit 5d3fb33866
18 changed files with 65 additions and 60 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
tools/man/man1/dmscntconv.1
View File

@@ -1,5 +1,5 @@
.\" -*- nroff -*-
.\" $Id: dmscntconv.1 721 2015-12-29 17:50:50Z mueller $
.\" $Id: dmscntconv.1 845 2017-01-15 14:58:27Z mueller $
.\"
.\" Copyright 2015- by Walter F.J. Mueller <W.F.J.Mueller@gsi.de>
.\"
@@ -13,7 +13,7 @@ dmscntconv \- convert dmscnt data
.SH SYNOPSIS
.
.SY dmscntconv
.OP \-\-src=seqvhd
.OP \-\-src=\fIseqvhd\fP
.I FILE
.
.SY dmscntconv

4
tools/man/man1/github_md2html.1
View File

@@ -1,5 +1,5 @@
.\" -*- nroff -*-
.\" $Id: github_md2html.1 837 2017-01-02 19:23:34Z mueller $
.\" $Id: github_md2html.1 845 2017-01-15 14:58:27Z mueller $
.\"
.\" Copyright 2017- by Walter F.J. Mueller <W.F.J.Mueller@gsi.de>
.\"
@@ -13,7 +13,7 @@ github_md2html \- convert markdown to html with GitHub API
.SH SYNOPSIS
.
.SY github_md2html
.OP OPTIONS
.RI [ OPTION ]...
.I FILE...
.YS
.

8
tools/man/man1/tbfilt.1
View File

@@ -1,5 +1,5 @@
.\" -*- nroff -*-
.\" $Id: tbfilt.1 803 2016-08-28 12:39:00Z mueller $
.\" $Id: tbfilt.1 845 2017-01-15 14:58:27Z mueller $
.\"
.\" Copyright 2016- by Walter F.J. Mueller <W.F.J.Mueller@gsi.de>
.\"
@@ -15,10 +15,10 @@ tbfilt \- filter for and analysis of test bench log files
.SY tbfilt
.B \-\-tee
.I OFILE
.OP OPTIONS
.RI [ OPTION ]...
.
.SY tbfilt
.OP OPTIONS
.RI [ OPTION ]...
.RI [ FILES ]...
.YS
.
@@ -282,7 +282,7 @@ Usually used together with \fBtbw\fP(1) in pipelines like
.EE
Since tbfilt expects also the output of a \fBbash\fP(1) 'time' command
in the input stream the setup of the pipeline is more involved.
In general the wrapper scripts \fB\tbrun_tbw\fP(1) or \fBtbrun_tbwrri\fP(1)
In general the wrapper scripts \fBtbrun_tbw\fP(1) or \fBtbrun_tbwrri\fP(1)
are used.
.
.SS As Analysis Tool

20
tools/man/man1/tbrun.1
View File

@@ -1,5 +1,5 @@
.\" -*- nroff -*-
.\" $Id: tbrun.1 812 2016-10-03 18:39:50Z mueller $
.\" $Id: tbrun.1 845 2017-01-15 14:58:27Z mueller $
.\"
.\" Copyright 2016- by Walter F.J. Mueller <W.F.J.Mueller@gsi.de>
.\"
@@ -13,8 +13,8 @@ tbrun \- test bench driver
.SH SYNOPSIS
.
.SY tbrun
.OP OPTIONS
.OP DSCFILE
.RI [ OPTION ]...
.RI [ DSCFILE ]
.YS
.
.\" ------------------------------------------------------------------
@@ -92,7 +92,7 @@ Other supported values for \fIengine\fP are
.IP \fBISim\fP 6
the Xilinx ISE build-in simulator
.IP \fBXSim\fP
the Xilinx vivado build-in simulator
the Xilinx Vivado build-in simulator
.PD
.RE
@@ -106,13 +106,13 @@ post-synthesis functional simulation
.IP \fBfsim\fP
post-map simulation (only ISE)
.IP \fBosim\fP
post-optimize functional simulation (only vivado)
post-optimize functional simulation (only Vivado)
.IP \fBrsim\fP
post-routing functional simulation (only vivado)
post-routing functional simulation (only Vivado)
.IP \fBesim\fP
post-synthesis timing simulation (only vivado)
post-synthesis timing simulation (only Vivado)
.IP \fBpsim\fP
post-optimize timing simulation (only vivado)
post-optimize timing simulation (only Vivado)
.IP \fBtsim\fP
post-routing timing simulation
.PD
@@ -171,10 +171,10 @@ use the \fB\-\-tee\fP instead to save the output into a file.
.\" -- --dry -------------------------------------
.IP \fB\-\-dry\fP
dry run, prints the generated commands, but doesn't execute.
When used without \f\-\-jobs\fP option a commented list of shell commands
When used without \-\-jobs\fP option a commented list of shell commands
is printed which describes the linear execution of the selected tests.
.br
When used together with \f\-\-jobs\fP this option mainly serves to debug
When used together with \-\-jobs\fP this option mainly serves to debug
the task dispatcher. A random wait of 0.2 to 1.8 sec is generated for each
selected test.
.

6
tools/man/man1/tbrun_tbw.1
View File

@@ -1,5 +1,5 @@
.\" -*- nroff -*-
.\" $Id: tbrun_tbw.1 800 2016-08-21 22:02:49Z mueller $
.\" $Id: tbrun_tbw.1 845 2017-01-15 14:58:27Z mueller $
.\"
.\" Copyright 2016- by Walter F.J. Mueller <W.F.J.Mueller@gsi.de>
.\"
@@ -13,9 +13,9 @@ tbrun_tbw \- \fBtbw\fP based test bench starter
.SH SYNOPSIS
.
.SY tbrun_tbw
.OP OPTIONS
.RI [ OPTION ]...
.I TBENCH
.OP STIMFILE
.RI [ STIMFILE ]
.YS
.
.\" ------------------------------------------------------------------

6
tools/man/man1/tbrun_tbwrri.1
View File

@@ -1,5 +1,5 @@
.\" -*- nroff -*-
.\" $Id: tbrun_tbwrri.1 808 2016-09-17 13:02:46Z mueller $
.\" $Id: tbrun_tbwrri.1 845 2017-01-15 14:58:27Z mueller $
.\"
.\" Copyright 2016- by Walter F.J. Mueller <W.F.J.Mueller@gsi.de>
.\"
@@ -13,9 +13,9 @@ tbrun_tbw \- \fBti_rri\fP plus \fBtbw\fP based test bench starter
.SH SYNOPSIS
.
.SY tbrun_tbwrri
.OP OPTIONS
.RI [ OPTION ]...
.I TBENCH
.OP COMMANDS
.RI [ COMMAND ]...
.YS
.
.\" ------------------------------------------------------------------

6
tools/man/man1/tbw.1
View File

@@ -1,5 +1,5 @@
.\" -*- nroff -*-
.\" $Id: tbw.1 810 2016-10-02 16:51:12Z mueller $
.\" $Id: tbw.1 845 2017-01-15 14:58:27Z mueller $
.\"
.\" Copyright 2013-2016 by Walter F.J. Mueller <W.F.J.Mueller@gsi.de>
.\"
@@ -14,9 +14,9 @@ tbw \- wrapper script to start ghdl based VHDL test benches
.
.SY tbw
.I TBPROG
.RI [ OPTIONS ]
.RI [ OPTION ]...
.RI [ FILEDEF ]...
.RI [ GHDL-OPTIONS ]...
.RI [ GHDL-OPTION ]...
.
.SY tbw
.B \-\-help

6
tools/man/man1/ti_rri.1
View File

@@ -1,5 +1,5 @@
.\" -*- nroff -*-
.\" $Id: ti_rri.1 843 2017-01-08 18:15:27Z mueller $
.\" $Id: ti_rri.1 845 2017-01-15 14:58:27Z mueller $
.\"
.\" Copyright 2013-2017 by Walter F.J. Mueller <W.F.J.Mueller@gsi.de>
.\"
@@ -13,8 +13,8 @@ ti_rri \- \fBRlink\fP Backend Server
.SH SYNOPSIS
.
.SY ti_rri
.OP OPTIONS
.OP COMMANDS
.RI [ OPTION ]...
.RI [ COMMAND ]...
.YS
.
.\" ------------------------------------------------------------------

11
tools/man/man1/ti_w11.1
View File

@@ -1,11 +1,11 @@
.\" -*- nroff -*-
.\" $Id: ti_w11.1 843 2017-01-08 18:15:27Z mueller $
.\" $Id: ti_w11.1 845 2017-01-15 14:58:27Z mueller $
.\"
.\" Copyright 2013-2017 by Walter F.J. Mueller <W.F.J.Mueller@gsi.de>
.\"
.\" ------------------------------------------------------------------
.
.TH TI_W11 1 2017-01-08 "Retro Project" "Retro Project Manual"
.TH TI_W11 1 2017-01-14 "Retro Project" "Retro Project Manual"
.\" ------------------------------------------------------------------
.SH NAME
ti_w11 \- Quick starter for \fBti_rri\fP with \fBw11\fP CPU designs
@@ -13,8 +13,9 @@ ti_w11 \- Quick starter for \fBti_rri\fP with \fBw11\fP CPU designs
.SH SYNOPSIS
.
.SY ti_w11
.OP OPTIONS
.OP "ti_rri options and commands"
.RI [ OPTION ]...
.RI [ "ti_rri option" ]...
.RI [ "ti_rri command" ]...
.YS
.
.\" ------------------------------------------------------------------
@@ -108,7 +109,7 @@ set rlink dump level to \fIn\fR (will issue a --dmpl=\fIn\fR).
set rlink I/O trace level to \fIn\fR (will issue a --tiol=\fIn\fR).
.IP \fB-b\fR
batch mode
.IP \fB-e "\fR=\fIfile"\fR
.IP "\fB-e \fR\fIfile\fR"
load and execute \fIfile\fP. If the file type is '.mac' the file will
be on the fly compiled with \fBasm-11\fP(1), for all other file types
it is assumed that they are in \fBlda\fP(5) format.

11
tools/man/man1/vbomconv.1
View File

@@ -1,12 +1,12 @@
.\" -*- nroff -*-
.\" $Id: vbomconv.1 783 2016-07-03 21:14:57Z mueller $
.\" $Id: vbomconv.1 845 2017-01-15 14:58:27Z mueller $
.\"
.\" Copyright 2010-2016 by Walter F.J. Mueller <W.F.J.Mueller@gsi.de>
.\"
.\"
.\" ------------------------------------------------------------------
.
.TH VBOMCONV 1 2016-07-02 "Retro Project" "Retro Project Manual"
.TH VBOMCONV 1 2017-01-15 "Retro Project" "Retro Project Manual"
.\" ------------------------------------------------------------------
.SH NAME
vbomconv \- generate files and actions from vbom manifest files
@@ -41,7 +41,7 @@ vbomconv \- generate files and actions from vbom manifest files
.BI \-\-ghdl_export "\fR=\fPpath"
.I vbom
.\" --- vivado
.\" --- Vivado
.SY vbomconv
.OP \-\-trace
.B \-\-vsyn_prj
@@ -260,7 +260,9 @@ or simprim libraries are located. This option is mandatory for
\fB\-\-ghdl_a\fP and \fB\-\-ghdl_m\fP commands when the design contains
a \fB@lib\fP directive.
These compiled libs are typically created with the
\fBxise_ghdl_unisim\fP(1) or \fBxise_ghdl_simprim\fP(1) commands.
\fBxviv_ghdl_unisim\fP(1) command for Vivado and
\fBxise_ghdl_unisim\fP(1) or \fBxise_ghdl_simprim\fP(1) commands
for ISE environments.
.
.\" --------------------------------------------------------
.SH ACTIONS
@@ -581,6 +583,7 @@ output like in
.BR xtwv (1),
.BR cpp (1),
.br
.BR xviv_ghdl_unisim (1),
.BR xise_ghdl_simprim (1),
.BR xise_ghdl_unisim (1)
.

4
tools/man/man1/xise_ghdl_simprim.1
View File

@@ -1,5 +1,5 @@
.\" -*- nroff -*-
.\" $Id: xise_ghdl_simprim.1 782 2016-07-03 08:09:36Z mueller $
.\" $Id: xise_ghdl_simprim.1 845 2017-01-15 14:58:27Z mueller $
.\"
.\" Copyright 2010-2016 by Walter F.J. Mueller <W.F.J.Mueller@gsi.de>
.\"
@@ -13,7 +13,7 @@ xise_ghdl_simprim \- compile Xilinx ISE SIMPRIM libraries for ghdl
.SH SYNOPSIS
.
.SY xise_ghdl_simprim
.RI [ GHDL-OPTIONS ]...
.RI [ GHDL-OPTION ]...
.YS
.
.\" ------------------------------------------------------------------

4
tools/man/man1/xise_ghdl_unisim.1
View File

@@ -1,5 +1,5 @@
.\" -*- nroff -*-
.\" $Id: xise_ghdl_unisim.1 782 2016-07-03 08:09:36Z mueller $
.\" $Id: xise_ghdl_unisim.1 845 2017-01-15 14:58:27Z mueller $
.\"
.\" Copyright 2010-2016 by Walter F.J. Mueller <W.F.J.Mueller@gsi.de>
.\"
@@ -13,7 +13,7 @@ xise_ghdl_unisim \- compile Xilinx ISE UNISIM and UNIMACRO libraries for ghdl
.SH SYNOPSIS
.
.SY xise_ghdl_unisim
.RI [ GHDL-OPTIONS ]...
.RI [ GHDL-OPTION ]...
.YS
.
.\" ------------------------------------------------------------------

4
tools/man/man1/xtwi.1
View File

@@ -1,5 +1,5 @@
.\" -*- nroff -*-
.\" $Id: xtwi.1 746 2016-03-19 13:08:36Z mueller $
.\" $Id: xtwi.1 845 2017-01-15 14:58:27Z mueller $
.\"
.\" Copyright 2014-2016 by Walter F.J. Mueller <W.F.J.Mueller@gsi.de>
.\"
@@ -13,7 +13,7 @@ xtwi \- Xilinx Tool Wrapper script for ISE
.SH SYNOPSIS
.
.SY xtwi
.OP COMMAND
.RI [ COMMAND ]
.YS
.
.\" ------------------------------------------------------------------

4
tools/man/man1/xtwv.1
View File

@@ -1,5 +1,5 @@
.\" -*- nroff -*-
.\" $Id: xtwv.1 746 2016-03-19 13:08:36Z mueller $
.\" $Id: xtwv.1 845 2017-01-15 14:58:27Z mueller $
.\"
.\" Copyright 2014-2016 by Walter F.J. Mueller <W.F.J.Mueller@gsi.de>
.\"
@@ -13,7 +13,7 @@ xtwv \- Xilinx Tool Wrapper script for Vivado
.SH SYNOPSIS
.
.SY xtwv
.OP COMMAND
.RI [ COMMAND ]
.YS
.
.\" ------------------------------------------------------------------

4
tools/man/man1/xviv_ghdl_unisim.1
View File

@@ -1,5 +1,5 @@
.\" -*- nroff -*-
.\" $Id: xviv_ghdl_unisim.1 782 2016-07-03 08:09:36Z mueller $
.\" $Id: xviv_ghdl_unisim.1 845 2017-01-15 14:58:27Z mueller $
.\"
.\" Copyright 2015-2016 by Walter F.J. Mueller <W.F.J.Mueller@gsi.de>
.\"
@@ -13,7 +13,7 @@ xviv_ghdl_unisim \- compile Xilinx Vivado UNISIM and UNIMACRO libraries for ghdl
.SH SYNOPSIS
.
.SY xviv_ghdl_unisim
.RI [ GHDL-OPTIONS ]...
.RI [ GHDL-OPTION ]...
.YS
.
.\" ------------------------------------------------------------------

6
tools/man/man1/xviv_msg_filter.1
View File

@@ -1,5 +1,5 @@
.\" -*- nroff -*-
.\" $Id: xviv_msg_filter.1 779 2016-06-26 15:37:16Z mueller $
.\" $Id: xviv_msg_filter.1 845 2017-01-15 14:58:27Z mueller $
.\"
.\" Copyright 2016- by Walter F.J. Mueller <W.F.J.Mueller@gsi.de>
.\"
@@ -90,7 +90,7 @@ notifivation is printed.
.PD
.RE
.IP \fBname\fP
vivado message name, enclosed in [] brackets
Vivado message name, enclosed in [] brackets
.IP \fBpattern\fP
regular expression to match the message text. This field is optional, if
omitted all messages with th given name will match. '[' and ']' characters
@@ -117,7 +117,7 @@ can't be opened an exit status 1 is returned.
.\" ------------------------------------------------------------------
.SH EXAMPLES
.IP "\fBxviv_msg_filter syn proj.vmfset proj_syn.log\fR" 4
Generate a short summary of the vivado synthesis log file.
Generate a short summary of the Vivado synthesis log file.
.
.\" ------------------------------------------------------------------
.SH "SEE ALSO"

11
tools/man/man1/xviv_sim_vhdl_cleanup.1
View File

@@ -1,5 +1,5 @@
.\" -*- nroff -*-
.\" $Id: xviv_sim_vhdl_cleanup.1 779 2016-06-26 15:37:16Z mueller $
.\" $Id: xviv_sim_vhdl_cleanup.1 845 2017-01-15 14:58:27Z mueller $
.\"
.\" Copyright 2016- by Walter F.J. Mueller <W.F.J.Mueller@gsi.de>
.\"
@@ -7,7 +7,7 @@
.TH XVIV_SIM_VHDL_CLEANUP 1 2016-06-05 "Retro Project" "Retro Project Manual"
.\" ------------------------------------------------------------------
.SH NAME
xviv_sim_vhdl_cleanup \- cleanup vivado generated vhdl for ghdl
xviv_sim_vhdl_cleanup \- cleanup Vivado generated vhdl for ghdl
.\" ------------------------------------------------------------------
.SH SYNOPSIS
.
@@ -18,9 +18,10 @@ xviv_sim_vhdl_cleanup \- cleanup vivado generated vhdl for ghdl
.\" ------------------------------------------------------------------
.SH DESCRIPTION
.\" ----------------------------------------------
The vivado write_vhdl command generates code which violates a vhdl language
rule. Attributes of port signals are declared in the architecture, but should
be in the entiry declaration. xsim and other simulators accept this, but
The Vivado \fIwrite_vhdl\fP command generates code which violates a vhdl
language rule.
Attributes of port signals are declared in the architecture, but should be in
the entiry declaration. xsim and other simulators accept this, but
\fBghdl\fP(1) doesn't. This script simply filters out lines like
.EX
attribute .... RTL_KEEP

6
tools/man/man5/vbom.5
View File

@@ -1,11 +1,11 @@
.\" -*- nroff -*-
.\" $Id: vbom.5 782 2016-07-03 08:09:36Z mueller $
.\" $Id: vbom.5 845 2017-01-15 14:58:27Z mueller $
.\"
.\" Copyright 2010-2016 by Walter F.J. Mueller <W.F.J.Mueller@gsi.de>
.\" Copyright 2010-2017 by Walter F.J. Mueller <W.F.J.Mueller@gsi.de>
.\"
.\" ------------------------------------------------------------------
.
.TH VBOM 2016-07-02 "Retro Project" "Retro Project Manual"
.TH VBOM 5 2016-07-02 "Retro Project" "Retro Project Manual"
.\" ------------------------------------------------------------------
.SH NAME
vbom \- vhdl manifest file format - 'vhdl bill of material'