rooty/Arduino
1
0
Fork 0
mirror of https://github.com/arduino/Arduino.git synced 2024-12-01 12:24:14 +01:00
Code Issues Releases Activity

Boards and Library manager command line interface documentation

Browse Source
This commit is contained in:
Federico Fissore 2015-04-09 10:48:44 +02:00
parent f155601c5e
commit 9833de618d
1 changed files with 36 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

47
build/shared/manpage.adoc
View File

@ -27,6 +27,12 @@ SYNOPSIS
*arduino* [*--verify*|*--upload*] [*--board* __package__:__arch__:__board__[:__parameters__]] [*--port* __portname__] [*--pref* __name__=__value__] [*-v*|*--verbose*] [__FILE.ino__] *arduino* [*--verify*|*--upload*] [*--board* __package__:__arch__:__board__[:__parameters__]] [*--port* __portname__] [*--pref* __name__=__value__] [*-v*|*--verbose*] [__FILE.ino__]
*arduino* [*--get-pref* __preference__]
*arduino* [*--install-board* __package name__:__platform name__[:__version__]]
*arduino* [*--install-library* __library name__[:__version__]]
DESCRIPTION DESCRIPTION
----------- -----------
The 'arduino' integrated development environment allows editing, The 'arduino' integrated development environment allows editing,
@ -49,6 +55,25 @@ between multiple runs and only recompile the files that changed.
Note that on MacOS X, the main executable is Note that on MacOS X, the main executable is
'Arduino.app/Contents/MacOS/JavaApplicationStub' instead of 'arduino'. 'Arduino.app/Contents/MacOS/JavaApplicationStub' instead of 'arduino'.
ACTIONS
*--verify*::
Build the sketch.
*--upload*::
Build and upload the sketch.
*--get-pref* __preference__::
Prints the value of the given preference to the standard output
stream. When the value does not exist, nothing is printed and
the exit status is set (see EXIT STATUS below).
*--install-board* __package name__:__platform name__[:__version__]::
Fetches available board support (platform) list and install the specified one, along with its related tools. If __version__ is omitted, the latest is installed. If a platform with the same version is already installed, nothing is installed and program exits with exit code 1. If a platform with a different version is already installed, it's replaced.
*--install-library* __library name__[:__version__]::
Fetches available libraries list and install the specified one. If __version__ is omitted, the latest is installed. If a library with the same version is already installed, nothing is installed and program exits with exit code 1. If a library with a different version is already installed, it's replaced.
OPTIONS OPTIONS
------- -------
*--board* __package__:__arch__:__board__[:__parameters__]:: *--board* __package__:__arch__:__board__[:__parameters__]::
@ -130,17 +155,6 @@ OPTIONS
*--board*, *--port*, *--pref*, *--verbose*, *--verbose-build* and *--board*, *--port*, *--pref*, *--verbose*, *--verbose-build* and
*--verbose-upload* may alter the current preferences. *--verbose-upload* may alter the current preferences.
*--upload*::
Build and upload the sketch.
*--verify*::
Build the sketch.
*--get-pref __preference__*::
Prints the value of the given preference to the standard output
stream. When the value does not exist, nothing is printed and
the exit status is set (see EXIT STATUS below).
PREFERENCES PREFERENCES
----------- -----------
Arduino keeps a list of preferences, as simple name and value pairs. Arduino keeps a list of preferences, as simple name and value pairs.
@ -233,6 +247,14 @@ Change the selected board and build path and do nothing else.
arduino --pref build.path=/path/to/sketch/build --board arduino:avr:uno --save-prefs arduino --pref build.path=/path/to/sketch/build --board arduino:avr:uno --save-prefs
Install latest SAM board support
arduino --install-board "arduino:Arduino SAM Boards (32-bits ARM Cortex-M3)"
Install Bridge library version 1.0.0
arduino --install-library "Bridge:1.0.0"
HISTORY HISTORY
------- -------
1.5.2:: 1.5.2::
@ -262,6 +284,9 @@ HISTORY
1.5.8:: 1.5.8::
Introduced *--save-prefs*. Introduced *--save-prefs*.
1.6.4::
Introduced *--install-board* and *--install-library*.
{empty}:: {empty}::
*--pref* options are now not saved to the preferences file, just *--pref* options are now not saved to the preferences file, just
like *--board* and *--port*, unless *--save-prefs* is specified. like *--board* and *--port*, unless *--save-prefs* is specified.