[icestorm] 01/01: Add sensible content in all man pages

Ruben Undheim rubund-guest at moszumanska.debian.org
Wed Oct 7 21:07:31 UTC 2015


This is an automated email from the git hooks/post-receive script.

rubund-guest pushed a commit to branch master
in repository icestorm.

commit 895fb62a019520dac0ce2bc913a389d46593bc99
Author: Ruben Undheim <ruben.undheim at gmail.com>
Date:   Wed Oct 7 23:07:18 2015 +0200

    Add sensible content in all man pages
---
 debian/man/icebox_chipdb.txt |  6 +++---
 debian/man/icebox_colbuf.txt |  7 ++++---
 debian/man/icebox_diff.txt   |  6 ++----
 debian/man/icebox_html.txt   |  9 ++++++---
 debian/man/icebox_maps.txt   | 13 +++++++++----
 debian/man/icebox_vlog.txt   | 19 ++++++++++++++-----
 debian/man/icemulti.txt      | 11 ++++++-----
 debian/man/iceprog.txt       | 36 +++++++++++++++++++++++++++++++++---
 8 files changed, 77 insertions(+), 30 deletions(-)

diff --git a/debian/man/icebox_chipdb.txt b/debian/man/icebox_chipdb.txt
index b359b75..05b7439 100644
--- a/debian/man/icebox_chipdb.txt
+++ b/debian/man/icebox_chipdb.txt
@@ -1,12 +1,12 @@
 NAME
-  icebox-diff - blabla
+  icebox_chipdb - create chipdb for specified device
 
 SYNOPSIS
-  icebox-diff [options]
+  icebox_chipdb [options] [bitmap.txt]
 
 
 OPTIONS
-  #-h    help
+  -8    create for 8k device
 
  
 
diff --git a/debian/man/icebox_colbuf.txt b/debian/man/icebox_colbuf.txt
index b359b75..be851f8 100644
--- a/debian/man/icebox_colbuf.txt
+++ b/debian/man/icebox_colbuf.txt
@@ -1,12 +1,13 @@
 NAME
-  icebox-diff - blabla
+  icebox_colbuf - 
 
 SYNOPSIS
-  icebox-diff [options]
+  icebox-colbuf [options] [input.txt [output.txt]]
 
 
 OPTIONS
-  #-h    help
+  -c    check colbuf bits
+  -f    fix colbuf bits
 
  
 
diff --git a/debian/man/icebox_diff.txt b/debian/man/icebox_diff.txt
index b359b75..2f80678 100644
--- a/debian/man/icebox_diff.txt
+++ b/debian/man/icebox_diff.txt
@@ -1,12 +1,10 @@
 NAME
-  icebox-diff - blabla
+  icebox_diff -
 
 SYNOPSIS
-  icebox-diff [options]
+  icebox_diff [options]
 
 
-OPTIONS
-  #-h    help
 
  
 
diff --git a/debian/man/icebox_html.txt b/debian/man/icebox_html.txt
index b359b75..0f93fce 100644
--- a/debian/man/icebox_html.txt
+++ b/debian/man/icebox_html.txt
@@ -1,12 +1,15 @@
 NAME
-  icebox-diff - blabla
+  icebox_html - create html view of bitstream
 
 SYNOPSIS
-  icebox-diff [options]
+  icebox_html [options]
 
 
 OPTIONS
-  #-h    help
+  -x tile_x_coordinate
+  -y tile_y_coordinate
+  -d outdir
+  -8
 
  
 
diff --git a/debian/man/icebox_maps.txt b/debian/man/icebox_maps.txt
index b359b75..f022291 100644
--- a/debian/man/icebox_maps.txt
+++ b/debian/man/icebox_maps.txt
@@ -1,12 +1,17 @@
 NAME
-  icebox-diff - blabla
+  icebox_maps - 
 
 SYNOPSIS
-  icebox-diff [options]
+  icebox_maps -m bitmaps
+  icebox_maps -m io_tile_nets_l
+  icebox_maps -m io_tile_nets_r
+  icebox_maps -m io_tile_nets_t
+  icebox_maps -m io_tile_nets_b
+  icebox_maps -m logic_tile_nets
+  icebox_maps -m ramb_tile_nets
+  icebox_maps -m ramt_tile_nets
 
 
-OPTIONS
-  #-h    help
 
  
 
diff --git a/debian/man/icebox_vlog.txt b/debian/man/icebox_vlog.txt
index b359b75..9dd9bb7 100644
--- a/debian/man/icebox_vlog.txt
+++ b/debian/man/icebox_vlog.txt
@@ -1,14 +1,23 @@
 NAME
-  icebox-diff - blabla
+  icebox_vlog - convert bitstream in .txt format to verilog
 
 SYNOPSIS
-  icebox-diff [options]
+  icebox_vlog [options] [bitmap.txt]
 
+DESCRIPTIOIN
+  This tools converts a bitstream in .txt format (already converted with iceunpack) to a Verilog representation.
 
 OPTIONS
-  #-h    help
-
- 
+    -s  strip comments from output
+    -S  strip comments about interconn wires from output
+    -l  convert io tile port names to chip pin numbers
+    -L  lookup symbol names (using .sym statements in input)
+    -n <module-name>   name for the exported module (default: "chip")
+    -p <pcf-file>  use the set_io command from the specified pcf file
+    -P <pcf-file>   like -p, enable some hacks for pcf files created by the iCEcube2 placer.
+    -c  collect multi-bit ports
+    -R  enable IeRen database checks
+    -D  enable exactly-one-driver checks
 
 
 AUTHOR
diff --git a/debian/man/icemulti.txt b/debian/man/icemulti.txt
index b359b75..a0307a4 100644
--- a/debian/man/icemulti.txt
+++ b/debian/man/icemulti.txt
@@ -1,14 +1,15 @@
 NAME
-  icebox-diff - blabla
+  icemulti - 
 
 SYNOPSIS
-  icebox-diff [options]
+  icemulti [options] input-files
 
 
 OPTIONS
-  #-h    help
-
- 
+ -c  coldboot mode, power on reset image is selected by CBSEL0/CBSEL1
+ -p0, -p1, -p2, -p3   select power on reset image when not using coldboot mode
+ -o filename   write output image to file instead of stdout
+ -v   verbose (repeat to increase verbosity)
 
 
 AUTHOR
diff --git a/debian/man/iceprog.txt b/debian/man/iceprog.txt
index b359b75..962d7f4 100644
--- a/debian/man/iceprog.txt
+++ b/debian/man/iceprog.txt
@@ -1,12 +1,42 @@
 NAME
-  icebox-diff - blabla
+  iceprog - simple programming tool for FTDI-based Lattice iCE programmers
 
 SYNOPSIS
-  icebox-diff [options]
+  iceprog [options] <filename>
+
+DESCRIPTION
+
+Notes for iCEstick (iCE40HX-1k devel board):
+
+  An unmodified iCEstick can only be programmed via the serial flash.
+  Direct programming of the SRAM is not supported. For direct SRAM
+  programming the flash chip and one zero ohm resistor must be desoldered
+  and the FT2232H SI pin must be connected to the iCE SPI_SI pin, as shown
+  in this picture: http://www.clifford.at/gallery/2014-elektronik/IMG_20141115_183838
+
+
+Notes for the iCE40-HX8K Breakout Board:
+
+  Make sure that the jumper settings on the board match the selected
+  mode (SRAM or FLASH). See the iCE40-HX8K user manual for details.
 
 
 OPTIONS
-  #-h    help
+
+    -d <device-string>  use the specified USB device:
+            d:<devicenode>                (e.g. d:002/005)
+            i:<vendor>:<product>          (e.g. i:0x0403:0x6010)
+            i:<vendor>:<product>:<index>  (e.g. i:0x0403:0x6010:0)
+            s:<vendor>:<product>:<serial-string>
+    -I [ABCD]  connect to the specified interface on the FTDI chip
+    -r  read entire flash (32Mb / 4MB) and write to file
+    -R  read first 256 kB from flash and write to file
+    -c  do not write flash, only verify (check)
+    -b  bulk erase entire flash before writing
+    -n  do not erase flash before writing
+    -S  perform SRAM programming
+    -t  just read the flash ID sequence
+    -v  verbose output
 
  
 

-- 
Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/debian-science/packages/icestorm.git



More information about the debian-science-commits mailing list