Merge branch 'unstable'
[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 *-W* '<image width>'::
39     the width of the image to upload
40
41 *-H* '<image height>'::
42     the height of the image to upload
43
44 *-h*::
45     this help message
46
47
48 EXAMPLE OF USE
49 --------------
50
51 picoproj -f file.jpg -F 1 -l 5 -W 800 -H 480
52
53
54 EXIT STATUS
55 -----------
56 *0*::
57     Success
58
59 *!0*::
60     Failure (libam7xxx error)
61
62
63 AUTHORS
64 -------
65 Antonio Ospite and Reto Schneider
66
67
68 RESOURCES
69 ---------
70 Main web site: <http://git.ao2.it/libam7xxx.git>
71
72
73 COPYING
74 -------
75 Copyright \(C) 2012  Antonio Ospite <ospite@studenti.unina.it>
76
77 This program is free software: you can redistribute it and/or modify
78 it under the terms of the GNU General Public License as published by
79 the Free Software Foundation, either version 3 of the License, or
80 (at your option) any later version.