From 1cb1a541bedd4e17085ab8ce04d0f5b2fc4d8d1d Mon Sep 17 00:00:00 2001 From: Matthias Vogelgesang Date: Wed, 10 Apr 2013 12:50:16 +0200 Subject: Update documentation --- docs/manual.md | 19 ++++++++++++++----- 1 file changed, 14 insertions(+), 5 deletions(-) diff --git a/docs/manual.md b/docs/manual.md index 85584df..732e5c3 100644 --- a/docs/manual.md +++ b/docs/manual.md @@ -482,18 +482,27 @@ Several tools are available to ensure `libuca` works as expected. All of them are located in `build/test/` and some of them are installed with `make installed`. -## `grab` -- grabbing frames +## `uca-grab` -- grabbing frames Grab with frames with - $ ./grab camera-model + $ uca-grab --num-frames=10 camera-model -store them on disk as `frame-00000.raw`, `frame-000001.raw` ... and measure the -time to take them. The raw format is not format but a memory dump of the -buffers, so you might want to use [ImageJ][] to view them. +store them on disk as `frames.tif` if `libtiff` is installed, otherwise as +`frame-00000.raw`, `frame-000001.raw`. The raw format is a memory dump of the +frames, so you might want to use [ImageJ][] to view them. You can also specify +the output filename or filename prefix with the ``-o/--output`` option: + + $ uca-grab -n 10 --output=foobar.tif camera-model + +Instead of reading exactly _n_ frames, you can also specify a duration in +fractions of seconds: + + $ uca-grab --duration=0.25 camera-model [ImageJ]: http://rsbweb.nih.gov/ij/ + ## `control` -- simple graphical user interface Shows the frames and displays them on screen. Moreover, you can change the -- cgit v1.2.3