Skip to content

Commit 9833de6

Browse files
author
Federico Fissore
committed
Boards and Library manager command line interface documentation
1 parent f155601 commit 9833de6

File tree

1 file changed

+36
-11
lines changed

1 file changed

+36
-11
lines changed

build/shared/manpage.adoc

Lines changed: 36 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,12 @@ SYNOPSIS
2727

2828
*arduino* [*--verify*|*--upload*] [*--board* __package__:__arch__:__board__[:__parameters__]] [*--port* __portname__] [*--pref* __name__=__value__] [*-v*|*--verbose*] [__FILE.ino__]
2929

30+
*arduino* [*--get-pref* __preference__]
31+
32+
*arduino* [*--install-board* __package name__:__platform name__[:__version__]]
33+
34+
*arduino* [*--install-library* __library name__[:__version__]]
35+
3036
DESCRIPTION
3137
-----------
3238
The 'arduino' integrated development environment allows editing,
@@ -49,6 +55,25 @@ between multiple runs and only recompile the files that changed.
4955
Note that on MacOS X, the main executable is
5056
'Arduino.app/Contents/MacOS/JavaApplicationStub' instead of 'arduino'.
5157

58+
ACTIONS
59+
60+
*--verify*::
61+
Build the sketch.
62+
63+
*--upload*::
64+
Build and upload the sketch.
65+
66+
*--get-pref* __preference__::
67+
Prints the value of the given preference to the standard output
68+
stream. When the value does not exist, nothing is printed and
69+
the exit status is set (see EXIT STATUS below).
70+
71+
*--install-board* __package name__:__platform name__[:__version__]::
72+
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.
73+
74+
*--install-library* __library name__[:__version__]::
75+
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.
76+
5277
OPTIONS
5378
-------
5479
*--board* __package__:__arch__:__board__[:__parameters__]::
@@ -130,17 +155,6 @@ OPTIONS
130155
*--board*, *--port*, *--pref*, *--verbose*, *--verbose-build* and
131156
*--verbose-upload* may alter the current preferences.
132157

133-
*--upload*::
134-
Build and upload the sketch.
135-
136-
*--verify*::
137-
Build the sketch.
138-
139-
*--get-pref __preference__*::
140-
Prints the value of the given preference to the standard output
141-
stream. When the value does not exist, nothing is printed and
142-
the exit status is set (see EXIT STATUS below).
143-
144158
PREFERENCES
145159
-----------
146160
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.
233247

234248
arduino --pref build.path=/path/to/sketch/build --board arduino:avr:uno --save-prefs
235249

250+
Install latest SAM board support
251+
252+
arduino --install-board "arduino:Arduino SAM Boards (32-bits ARM Cortex-M3)"
253+
254+
Install Bridge library version 1.0.0
255+
256+
arduino --install-library "Bridge:1.0.0"
257+
236258
HISTORY
237259
-------
238260
1.5.2::
@@ -262,6 +284,9 @@ HISTORY
262284
1.5.8::
263285
Introduced *--save-prefs*.
264286
287+
1.6.4::
288+
Introduced *--install-board* and *--install-library*.
289+
265290
{empty}::
266291
*--pref* options are now not saved to the preferences file, just
267292
like *--board* and *--port*, unless *--save-prefs* is specified.

0 commit comments

Comments
 (0)