debian man page for ard-parse-boards

ARD-PARSE-BOARDS(1)					      General Commands Manual					       ARD-PARSE-BOARDS(1)

NAME
       ard-parse-boards - Read data from the Arduino boards.txt file

USAGE
       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

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.

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

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

       --dump Dump the complete database in YAML format.

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

       --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.

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

       Please report problems to the author.

       Patches are welcome.

AUTHOR
       Martin Oldfield, ex-atelier@mjo.tc

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

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 MER-
       CHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.

								     MAY 2012						       ARD-PARSE-BOARDS(1)