Make example programs optional.
[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 a static image.
19
20
21 OPTIONS
22 -------
23
24 *-f* '<filename>'::
25     the image file to upload
26
27
28 *-F* '<format>'::
29     the image format to use (default is JPEG)
30 +
31 .SUPPORTED FORMATS:
32 * 1 - JPEG
33 * 2 - NV12
34
35 *-l* '<log level>'::
36     the verbosity level of libam7xxx output (0-5)
37
38 *-p* '<power level>'::
39     power level of device, between 0 (off) and 4 (maximum) +
40     WARNING: Level 2 and greater require the master AND
41              the slave connector to be plugged in.
42
43 *-W* '<image width>'::
44     the width of the image to upload
45
46 *-H* '<image height>'::
47     the height of the image to upload
48
49 *-h*::
50     this help message
51
52
53 EXAMPLE OF USE
54 --------------
55
56 picoproj -f file.jpg -F 1 -l 5 -W 800 -H 480
57
58
59 EXIT STATUS
60 -----------
61 *0*::
62     Success
63
64 *!0*::
65     Failure (libam7xxx error)
66
67
68 AUTHORS
69 -------
70 Antonio Ospite and Reto Schneider
71
72
73 RESOURCES
74 ---------
75 Main web site: <http://git.ao2.it/libam7xxx.git>
76
77
78 COPYING
79 -------
80 Copyright \(C) 2012  Antonio Ospite <ospite@studenti.unina.it>
81
82 This program is free software: you can redistribute it and/or modify
83 it under the terms of the GNU General Public License as published by
84 the Free Software Foundation, either version 3 of the License, or
85 (at your option) any later version.