[icestorm] 01/01: More sensible content in some man pages

Ruben Undheim rubund-guest at moszumanska.debian.org
Wed Oct 7 20:54:00 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 8254981ae34fb33b3885d67fd837a26e88a344ec
Author: Ruben Undheim <ruben.undheim at gmail.com>
Date:   Wed Oct 7 22:53:47 2015 +0200

    More sensible content in some man pages
---
 debian/man/icebox_explain.txt | 14 ++++++++++----
 debian/man/icepack.txt        | 19 ++++++++++++++-----
 debian/man/iceunpack.txt      | 19 ++++++++++++++-----
 3 files changed, 38 insertions(+), 14 deletions(-)

diff --git a/debian/man/icebox_explain.txt b/debian/man/icebox_explain.txt
index b359b75..ee8d7f7 100644
--- a/debian/man/icebox_explain.txt
+++ b/debian/man/icebox_explain.txt
@@ -1,15 +1,21 @@
 NAME
-  icebox-diff - blabla
+  icebox-explain - explain content of bitstream file in readable .txt format
 
 SYNOPSIS
-  icebox-diff [options]
+  icebox-explain [options] [bitmap.txt]
 
+DESCRIPTION
+  This tool can be used to get an understanding of the content of a .txt file that has been converted from a binary bistream with iceunpack.
 
 OPTIONS
-  #-h    help
+  -b    print config bit names for each config statement
+  -m    print tile config bitmaps
+  -A    don't skip uninteresting tiles
+  -t '<x-coordinate> <y-coordinate>'   print only the specified tile
 
  
-
+SEE ALSO
+  iceunpack(1)
 
 AUTHOR
   This manual page was written by Ruben Undheim <ruben.undheim at gmail.com> for the Debian project (and may be used by others).
diff --git a/debian/man/icepack.txt b/debian/man/icepack.txt
index b359b75..5215f8a 100644
--- a/debian/man/icepack.txt
+++ b/debian/man/icepack.txt
@@ -1,14 +1,23 @@
 NAME
-  icebox-diff - blabla
+  icepack - Packs readable .txt file description of a Lattice FPGA into binary bitstreams
 
 SYNOPSIS
-  icebox-diff [options]
+  icepack [options] [input-file [output-file]]
 
+DESCRIPTION
+  This tool can be used to create binary bitstreams for Lattice FPGA from readable .txt file. It is the reverse operation of what iceunpack do.
 
 OPTIONS
-  #-h    help
-
- 
+  -u    unpack mode (implied when called as 'iceunpack')
+  -v    verbose (repeat to increase verbosity)
+  -b    write cram bitmap as netpbm file
+  -f    write cram bitmap (fill tiles) as netpbm file
+  -c    write cram bitmap (checkerboard) as netpbm file. repeat to flip the selection of tiles
+  -r    write bram data, not cra, to the netpbm file
+  -B0,-B1,-B2,-B3   only include the specified banks in the netpbm file
+
+SEE ALSO
+  iceunpack(1) 
 
 
 AUTHOR
diff --git a/debian/man/iceunpack.txt b/debian/man/iceunpack.txt
index b359b75..832548b 100644
--- a/debian/man/iceunpack.txt
+++ b/debian/man/iceunpack.txt
@@ -1,14 +1,23 @@
 NAME
-  icebox-diff - blabla
+  iceunpack - Unpacks binary bitstreams for Lattice FPGA to readable .txt file
 
 SYNOPSIS
-  icebox-diff [options]
+  iceunpack [options] [input-file [output-file]]
 
+DESCRIPTION
+  This tool can be used to unpack binary bitstreams for Lattice FPGA. It is part of the icestorm project.
 
 OPTIONS
-  #-h    help
-
- 
+  -u    unpack mode (implied when called as 'iceunpack')
+  -v    verbose (repeat to increase verbosity)
+  -b    write cram bitmap as netpbm file
+  -f    write cram bitmap (fill tiles) as netpbm file
+  -c    write cram bitmap (checkerboard) as netpbm file. repeat to flip the selection of tiles
+  -r    write bram data, not cra, to the netpbm file
+  -B0,-B1,-B2,-B3   only include the specified banks in the netpbm file
+
+SEE ALSO
+  icepack(1) 
 
 
 AUTHOR

-- 
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