Skip to content

Commit 64f691b

Browse files
sanialessaniales
committed
Adding first skeleton of man pages
1 parent 792e5cf commit 64f691b

12 files changed

+430
-4
lines changed

‎docs/manpages.go

+18
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
package docs
2+
3+
import (
4+
"github.com/bcmi-labs/arduino-cli/cmd"
5+
"github.com/spf13/cobra/doc"
6+
)
7+
8+
// GenerateManPages generates man pages for all commands and puts them in $PROJECT_DIR/manpages
9+
func GenerateManPages() {
10+
header := &doc.GenManHeader{
11+
Title: "ARDUINO COMMAND LINE MANUAL",
12+
Section: "1",
13+
}
14+
//out := new(bytes.Buffer)
15+
//doc.GenMan(cmd.RootCmd, header, out)
16+
//fmt.Print(out.String())
17+
doc.GenManTree(cmd.RootCmd, header, "./docs/manpages")
18+
}

‎docs/manpages/arduino-config.1

+46
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
.TH "ARDUINO COMMAND LINE MANUAL" "1" "Jun 2017" "BCMI LABS SA" ""
2+
.nh
3+
.ad l
4+
5+
6+
.SH NAME
7+
.PP
8+
arduino\-config \- A brief description of your command
9+
10+
11+
.SH SYNOPSIS
12+
.PP
13+
\fBarduino config [flags]\fP
14+
15+
16+
.SH DESCRIPTION
17+
.PP
18+
A longer description that spans multiple lines and likely contains examples
19+
and usage of using your command. For example:
20+
21+
.PP
22+
Cobra is a CLI library for Go that empowers applications.
23+
This application is a tool to generate the needed files
24+
to quickly create a Cobra application.
25+
26+
27+
.SH OPTIONS
28+
.PP
29+
\fB\-h\fP, \fB\-\-help\fP[=false]
30+
help for config
31+
32+
33+
.SH OPTIONS INHERITED FROM PARENT COMMANDS
34+
.PP
35+
\fB\-v\fP, \fB\-\-verbose\fP[=0]
36+
enables verbose output (use more times for a higher level)
37+
38+
39+
.SH SEE ALSO
40+
.PP
41+
\fBarduino(1)\fP
42+
43+
44+
.SH HISTORY
45+
.PP
46+
14\-Jun\-2017 BCMI LABS SA

‎docs/manpages/arduino-lib-install.1

+40
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
.TH "ARDUINO COMMAND LINE MANUAL" "1" "Jun 2017" "BCMI LABS SA" ""
2+
.nh
3+
.ad l
4+
5+
6+
.SH NAME
7+
.PP
8+
arduino\-lib\-install \- Installs one of more specified libraries into the system.
9+
10+
11+
.SH SYNOPSIS
12+
.PP
13+
\fBarduino lib install [flags]\fP
14+
15+
16+
.SH DESCRIPTION
17+
.PP
18+
Installs one or more specified libraries into the system.
19+
20+
21+
.SH OPTIONS
22+
.PP
23+
\fB\-h\fP, \fB\-\-help\fP[=false]
24+
help for install
25+
26+
27+
.SH OPTIONS INHERITED FROM PARENT COMMANDS
28+
.PP
29+
\fB\-v\fP, \fB\-\-verbose\fP[=0]
30+
enables verbose output (use more times for a higher level)
31+
32+
33+
.SH SEE ALSO
34+
.PP
35+
\fBarduino\-lib(1)\fP
36+
37+
38+
.SH HISTORY
39+
.PP
40+
14\-Jun\-2017 BCMI LABS SA

‎docs/manpages/arduino-lib-list-update.1

+40
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
.TH "ARDUINO COMMAND LINE MANUAL" "1" "Jun 2017" "BCMI LABS SA" ""
2+
.nh
3+
.ad l
4+
5+
6+
.SH NAME
7+
.PP
8+
arduino\-lib\-list\-update \- Updates the library index to latest version
9+
10+
11+
.SH SYNOPSIS
12+
.PP
13+
\fBarduino lib list update [flags]\fP
14+
15+
16+
.SH DESCRIPTION
17+
.PP
18+
Updates the library index to latest version from downloads.arduino.cc repository.
19+
20+
21+
.SH OPTIONS
22+
.PP
23+
\fB\-h\fP, \fB\-\-help\fP[=false]
24+
help for update
25+
26+
27+
.SH OPTIONS INHERITED FROM PARENT COMMANDS
28+
.PP
29+
\fB\-v\fP, \fB\-\-verbose\fP[=0]
30+
enables verbose output (use more times for a higher level)
31+
32+
33+
.SH SEE ALSO
34+
.PP
35+
\fBarduino\-lib\-list(1)\fP
36+
37+
38+
.SH HISTORY
39+
.PP
40+
14\-Jun\-2017 BCMI LABS SA

‎docs/manpages/arduino-lib-list.1

+41
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
.TH "ARDUINO COMMAND LINE MANUAL" "1" "Jun 2017" "BCMI LABS SA" ""
2+
.nh
3+
.ad l
4+
5+
6+
.SH NAME
7+
.PP
8+
arduino\-lib\-list \- Shows a list of all libraries from arduino repository.
9+
10+
11+
.SH SYNOPSIS
12+
.PP
13+
\fBarduino lib list [flags]\fP
14+
15+
16+
.SH DESCRIPTION
17+
.PP
18+
Shows a list of all libraries from arduino repository.
19+
Can be used with \-v (or \-\-verbose) flag (up to 2 times) to have longer output.
20+
21+
22+
.SH OPTIONS
23+
.PP
24+
\fB\-h\fP, \fB\-\-help\fP[=false]
25+
help for list
26+
27+
28+
.SH OPTIONS INHERITED FROM PARENT COMMANDS
29+
.PP
30+
\fB\-v\fP, \fB\-\-verbose\fP[=0]
31+
enables verbose output (use more times for a higher level)
32+
33+
34+
.SH SEE ALSO
35+
.PP
36+
\fBarduino\-lib(1)\fP, \fBarduino\-lib\-list\-update(1)\fP
37+
38+
39+
.SH HISTORY
40+
.PP
41+
14\-Jun\-2017 BCMI LABS SA

‎docs/manpages/arduino-lib-search.1

+40
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
.TH "ARDUINO COMMAND LINE MANUAL" "1" "Jun 2017" "BCMI LABS SA" ""
2+
.nh
3+
.ad l
4+
5+
6+
.SH NAME
7+
.PP
8+
arduino\-lib\-search \- Searchs for a library data
9+
10+
11+
.SH SYNOPSIS
12+
.PP
13+
\fBarduino lib search [flags]\fP
14+
15+
16+
.SH DESCRIPTION
17+
.PP
18+
Search for one or more libraries data.
19+
20+
21+
.SH OPTIONS
22+
.PP
23+
\fB\-h\fP, \fB\-\-help\fP[=false]
24+
help for search
25+
26+
27+
.SH OPTIONS INHERITED FROM PARENT COMMANDS
28+
.PP
29+
\fB\-v\fP, \fB\-\-verbose\fP[=0]
30+
enables verbose output (use more times for a higher level)
31+
32+
33+
.SH SEE ALSO
34+
.PP
35+
\fBarduino\-lib(1)\fP
36+
37+
38+
.SH HISTORY
39+
.PP
40+
14\-Jun\-2017 BCMI LABS SA

‎docs/manpages/arduino-lib-uninstall.1

+40
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
.TH "ARDUINO COMMAND LINE MANUAL" "1" "Jun 2017" "BCMI LABS SA" ""
2+
.nh
3+
.ad l
4+
5+
6+
.SH NAME
7+
.PP
8+
arduino\-lib\-uninstall \- Uninstalls one or more libraries
9+
10+
11+
.SH SYNOPSIS
12+
.PP
13+
\fBarduino lib uninstall [flags]\fP
14+
15+
16+
.SH DESCRIPTION
17+
.PP
18+
Uninstalls one or more libraries
19+
20+
21+
.SH OPTIONS
22+
.PP
23+
\fB\-h\fP, \fB\-\-help\fP[=false]
24+
help for uninstall
25+
26+
27+
.SH OPTIONS INHERITED FROM PARENT COMMANDS
28+
.PP
29+
\fB\-v\fP, \fB\-\-verbose\fP[=0]
30+
enables verbose output (use more times for a higher level)
31+
32+
33+
.SH SEE ALSO
34+
.PP
35+
\fBarduino\-lib(1)\fP
36+
37+
38+
.SH HISTORY
39+
.PP
40+
14\-Jun\-2017 BCMI LABS SA

‎docs/manpages/arduino-lib-version.1

+40
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
.TH "ARDUINO COMMAND LINE MANUAL" "1" "Jun 2017" "BCMI LABS SA" ""
2+
.nh
3+
.ad l
4+
5+
6+
.SH NAME
7+
.PP
8+
arduino\-lib\-version \- Shows version Number of arduino lib
9+
10+
11+
.SH SYNOPSIS
12+
.PP
13+
\fBarduino lib version [flags]\fP
14+
15+
16+
.SH DESCRIPTION
17+
.PP
18+
Shows version Number of arduino lib which is installed on your system.
19+
20+
21+
.SH OPTIONS
22+
.PP
23+
\fB\-h\fP, \fB\-\-help\fP[=false]
24+
help for version
25+
26+
27+
.SH OPTIONS INHERITED FROM PARENT COMMANDS
28+
.PP
29+
\fB\-v\fP, \fB\-\-verbose\fP[=0]
30+
enables verbose output (use more times for a higher level)
31+
32+
33+
.SH SEE ALSO
34+
.PP
35+
\fBarduino\-lib(1)\fP
36+
37+
38+
.SH HISTORY
39+
.PP
40+
14\-Jun\-2017 BCMI LABS SA

‎docs/manpages/arduino-lib.1

+40
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
.TH "ARDUINO COMMAND LINE MANUAL" "1" "Jun 2017" "BCMI LABS SA" ""
2+
.nh
3+
.ad l
4+
5+
6+
.SH NAME
7+
.PP
8+
arduino\-lib \- Shows all commands regarding libraries.
9+
10+
11+
.SH SYNOPSIS
12+
.PP
13+
\fBarduino lib [flags]\fP
14+
15+
16+
.SH DESCRIPTION
17+
.PP
18+
Shows all commands regarding libraries.
19+
20+
21+
.SH OPTIONS
22+
.PP
23+
\fB\-h\fP, \fB\-\-help\fP[=false]
24+
help for lib
25+
26+
27+
.SH OPTIONS INHERITED FROM PARENT COMMANDS
28+
.PP
29+
\fB\-v\fP, \fB\-\-verbose\fP[=0]
30+
enables verbose output (use more times for a higher level)
31+
32+
33+
.SH SEE ALSO
34+
.PP
35+
\fBarduino(1)\fP, \fBarduino\-lib\-install(1)\fP, \fBarduino\-lib\-list(1)\fP, \fBarduino\-lib\-search(1)\fP, \fBarduino\-lib\-uninstall(1)\fP, \fBarduino\-lib\-version(1)\fP
36+
37+
38+
.SH HISTORY
39+
.PP
40+
14\-Jun\-2017 BCMI LABS SA

‎docs/manpages/arduino-version.1

+40
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
.TH "ARDUINO COMMAND LINE MANUAL" "1" "Jun 2017" "BCMI LABS SA" ""
2+
.nh
3+
.ad l
4+
5+
6+
.SH NAME
7+
.PP
8+
arduino\-version \- Shows version Number of arduino
9+
10+
11+
.SH SYNOPSIS
12+
.PP
13+
\fBarduino version [flags]\fP
14+
15+
16+
.SH DESCRIPTION
17+
.PP
18+
Shows version Number of arduino which is installed on your system.
19+
20+
21+
.SH OPTIONS
22+
.PP
23+
\fB\-h\fP, \fB\-\-help\fP[=false]
24+
help for version
25+
26+
27+
.SH OPTIONS INHERITED FROM PARENT COMMANDS
28+
.PP
29+
\fB\-v\fP, \fB\-\-verbose\fP[=0]
30+
enables verbose output (use more times for a higher level)
31+
32+
33+
.SH SEE ALSO
34+
.PP
35+
\fBarduino(1)\fP
36+
37+
38+
.SH HISTORY
39+
.PP
40+
14\-Jun\-2017 BCMI LABS SA

0 commit comments

Comments
 (0)