File: ard-parse-boards.1

package info (click to toggle)
arduino-mk 0.8-5
  • links: PTS, VCS
  • area: main
  • in suites: wheezy
  • size: 252 kB
  • sloc: perl: 214; makefile: 4
file content (91 lines) | stat: -rw-r--r-- 2,689 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
.TH ARD-PARSE-BOARDS 1  "MAY 2012"
.SH NAME
ard-parse-boards \- Read data from the Arduino boards.txt file
.SH USAGE
.P
Dump all the data in the file:
 $ ard-parse-boards \-\-dump

See which boards we know about:
 $ ard-parse-boards \-\-boards

Look for a particular board...
 $ ard-parse-boards \-\-find uno

multiple terms are implicitly ANDed:
 $ ard-parse-boards \-\-find duemil 328

Dump all the data for a particular board:
 $ ard-parse-boards atmega328

Extract a particular field:
 $ ard-parse-boards atmega328 build.f_cpu

.SH DESCRIPTION
The Arduino software package ships with a boards.txt file which tells
the Arduino IDE details about particular hardware. So when the user
says he's got a shiny new Arduino Uno, boards.txt knows that it has a
16MHz ATmega328 on it. It would be nice to access these data from the
command line too.

In normal operation you simply specify the tag given to the board in
the boards.txt file, and optionally a field name. This program then
extracts the data to STDOUT.

Most boards have names which are quite unwieldy, so we always refer to
a board by a tag, not its name. Strictly the tag is the bit before the
first dot in the boards.txt key. You can see a list of board tags and
names with the "\-\-boards" option.

.SH OPTIONS
.IP "--boards_txt=[file]"
Specify the full path to the boards.txt file.

.P
The following options all disable the normal 'lookup' operation.

.IP --dump
Dump the complete database in YAML format.

.IP --boards
Print a list of the tag and name of every board in the file.

.IP "--find [query] <query> ..."
Find matching data. Strictly, return a list of values which match
all of the query terms, treating each term as a case-insensitive
regexp.

For example:
 \-\-find 328
 List data containing 328 (anywhere in the value).

 \-\-find due
 List data containing 'due' (e.g. duemilanove).

 \-\-find 328 due
 List data containing both 328 and due.

.SH BUGS AND LIMITATIONS
There are no known bugs in this application.

Please report problems to the author.

Patches are welcome.

.SH AUTHOR
Martin Oldfield, ex-atelier@mjo.tc

Thanks to Mark Sproul who suggested doing something like this to me
ages ago.

.SH LICENSE AND COPYRIGHT
Copyright (c) 2011, Martin Oldfield. All rights reserved.

This file is free software; you can redistribute it and/or modify it
under the terms of the GNU Lesser General Public License as published
by the Free Software Foundation; either version 2.1 of the License, or
(at your option) any later version.

This program is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.