HACKING.asciidoc: add an example of testing am7xxx-play with valgrind
[libam7xxx.git] / doc / man / picoproj.1.txt
1 PICOPROJ(1)
2 ===========
3 :doctype: manpage
4
5
6 NAME
7 ----
8 picoproj - test program for libam7xxx
9
10
11 SYNOPSIS
12 --------
13 *picoproj* ['OPTIONS']
14
15
16 DESCRIPTION
17 -----------
18 picoproj(1) is a minimal example to show how to use libam7xxx to display
19 a static image; it will not perform any image rescaling or conversion, images
20 larger than the device native resolution can be wrongly displayed.
21
22
23 OPTIONS
24 -------
25
26 *-d* '<index>'::
27     the device index (default is 0)
28
29 *-f* '<filename>'::
30     the image file to upload
31
32
33 *-F* '<format>'::
34     the image format to use (default is JPEG)
35 +
36 .SUPPORTED FORMATS:
37 * 1 - JPEG
38 * 2 - NV12
39
40 *-l* '<log level>'::
41     the verbosity level of libam7xxx output (0-5)
42
43 *-p* '<power mode>'::
44     the power mode of device, between 0 (off) and 4 (turbo) +
45     WARNING: Level 2 and greater require the master AND
46              the slave connector to be plugged in.
47
48 *-z* '<zoom mode>'::
49     the display zoom mode, between 0 (original) and 3 (test)
50
51 *-W* '<image width>'::
52     the width of the image to upload
53
54 *-H* '<image height>'::
55     the height of the image to upload
56
57 *-h*::
58     this help message
59
60
61 EXAMPLE OF USE
62 --------------
63
64 picoproj -f file.jpg -F 1 -l 5 -W 800 -H 480
65
66
67 EXIT STATUS
68 -----------
69 *0*::
70     Success
71
72 *!0*::
73     Failure (libam7xxx error)
74
75
76 AUTHORS
77 -------
78 Antonio Ospite and Reto Schneider
79
80
81 RESOURCES
82 ---------
83 Main web site: <http://git.ao2.it/libam7xxx.git>
84
85
86 COPYING
87 -------
88 Copyright \(C) 2012  Antonio Ospite <ospite@studenti.unina.it>
89
90 This program is free software: you can redistribute it and/or modify
91 it under the terms of the GNU General Public License as published by
92 the Free Software Foundation, either version 3 of the License, or
93 (at your option) any later version.