Skip to content

Commit

Permalink
doc: rename osdk to cutekit in manpage
Browse files Browse the repository at this point in the history
  • Loading branch information
d0p1s4m4 committed May 29, 2023
1 parent decc877 commit 971fe5a
Show file tree
Hide file tree
Showing 6 changed files with 102 additions and 36 deletions.
33 changes: 33 additions & 0 deletions docs/cutekit-build.1
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
.TH CUTEKIT\-BUILD 1 2023-02-27

.SH NAME
cutekit\-build \- Build target.

.SH SYNOPSIS
\fBcutekit build\fR [\fIoptions\fR]
.br
\fBcutekit b\fR [\fIoptions\fR]

.SH DESCRIPTION

.SH OPTIONS
.TP
\fB\-\-target\fR=\fItarget\fR
Build target \fItarget\fR.

.SH EXIT STATUS
exits with status 0.

.SH BUGS
See <https://github.com/cute-engineering/cutekit> for issues.

.SH COPYRIGHT
Copyright \(co 2023 Cute Engineering.
.br
License MIT: <https://opensource.org/license/mit/>.
.br
This is free software: you are free to change and redistribute it.
There is NO WARRANTY, to the extent permitted by law.

.SH SEE ALSO
.BR cutekit (1)
33 changes: 33 additions & 0 deletions docs/cutekit-debug.1
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
.TH CUTEKIT\-DEBUG 1 2023-02-27

.SH NAME
cutekit\-debug \- Debug target.

.SH SYNOPSIS
\fBcutekit debug\fR [\fIoptions\fR]
.br
\fBcutekit d\fR [\fIoptions\fR]

.SH DESCRIPTION

.SH OPTIONS
.TP
\fB\-\-target\fR=\fItarget\fR
Debug target \fItarget\fR.

.SH EXIT STATUS
exits with status 0.

.SH BUGS
See <https://github.com/cute-engineering/cutekit> for issues.

.SH COPYRIGHT
Copyright \(co 2023 Cute Engineering.
.br
License MIT: <https://opensource.org/license/mit/>.
.br
This is free software: you are free to change and redistribute it.
There is NO WARRANTY, to the extent permitted by law.

.SH SEE ALSO
.BR cutekit (1)
12 changes: 6 additions & 6 deletions docs/osdk-graph.1 → docs/cutekit-graph.1
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
.TH OSDK\-GRAPH 1 2023-02-27
.TH CUTEKIT\-GRAPH 1 2023-02-27

.SH NAME
osdk\-graph \- Show dependency graph.
cutekit\-graph \- Show dependency graph.

.SH SYNOPSIS
\fBosdk graph\fR [\fIoptions\fR]
\fBcutekit graph\fR [\fIoptions\fR]
.br
\fBosdk g\fR [\fIoptions\fR]
\fBcutekit g\fR [\fIoptions\fR]

.SH DESCRIPTION
This command will display a dependency graph using graphviz.
Expand All @@ -27,7 +27,7 @@ exits with status 0 if all operations were successfull, greater than 0 if
errors occur.

.SH BUGS
See <https://github.com/cute-engineering/osdk> for issues.
See <https://github.com/cute-engineering/cutekit> for issues.

.SH COPYRIGHT
Copyright \(co 2023 Cute Engineering.
Expand All @@ -38,4 +38,4 @@ This is free software: you are free to change and redistribute it.
There is NO WARRANTY, to the extent permitted by law.

.SH SEE ALSO
.BR osdk (1)
.BR cutekit (1)
12 changes: 6 additions & 6 deletions docs/osdk-help.1 → docs/cutekit-help.1
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
.TH OSDK\-HELP 1 2023-02-27
.TH CUTEKIT\-HELP 1 2023-02-27

.SH NAME
osdk\-help \- Display help information.
cutekit\-help \- Display help information.

.SH SYNOPSIS
\fBosdk help\fR
\fBcutekit help\fR
.br
\fBosdk h\fR
\fBcutekit h\fR

.SH DESCRIPTION
This command display help information and exit.
Expand All @@ -15,7 +15,7 @@ This command display help information and exit.
exits with status 0.

.SH BUGS
See <https://github.com/cute-engineering/osdk> for issues.
See <https://github.com/cute-engineering/cutekit> for issues.

.SH COPYRIGHT
Copyright \(co 2023 Cute Engineering.
Expand All @@ -26,4 +26,4 @@ This is free software: you are free to change and redistribute it.
There is NO WARRANTY, to the extent permitted by law.

.SH SEE ALSO
.BR osdk (1)
.BR cutekit (1)
12 changes: 6 additions & 6 deletions docs/osdk-run.1 → docs/cutekit-run.1
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
.TH OSDK\-RUN 1 2023-02-27
.TH CUTEKIT\-RUN 1 2023-02-27

.SH NAME
osdk\-run \- Run target.
cutekit\-run \- Run target.

.SH SYNOPSIS
\fBosdk run\fR [\fIoptions\fR]
\fBcutekit run\fR [\fIoptions\fR]
.br
\fBosdk r\fR [\fIoptions\fR]
\fBcutekit r\fR [\fIoptions\fR]

.SH DESCRIPTION

Expand All @@ -19,7 +19,7 @@ Run target \fItarget\fR.
exits with status 0.

.SH BUGS
See <https://github.com/cute-engineering/osdk> for issues.
See <https://github.com/cute-engineering/cutekit> for issues.

.SH COPYRIGHT
Copyright \(co 2023 Cute Engineering.
Expand All @@ -30,4 +30,4 @@ This is free software: you are free to change and redistribute it.
There is NO WARRANTY, to the extent permitted by law.

.SH SEE ALSO
.BR osdk (1)
.BR cutekit (1)
36 changes: 18 additions & 18 deletions docs/osdk.1 → docs/cutekit.1
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
.TH OSDK 1 2023-02-27
.TH CUTEKIT 1 2023-02-27

.SH NAME
osdk \- Operating System Development Kit.
cutekit \- Operating System Development Kit.

.SH SYNOPSIS
\fBosdk\fR \fIcommand\fR [\fIargs...\fR]
\fBcutekit\fR \fIcommand\fR [\fIargs...\fR]
.br
\fBosdk\fR \fIhelp\fP
\fBcutekit\fR \fIhelp\fP

.SH DESCRIPTION
This program is a package manager and build tool for Operating System
Expand All @@ -15,55 +15,55 @@ development.
.SH COMMANDS
.SS Build Commands
.TP
\fBosdk-run\fR(1)
\fBcutekit-run\fR(1)
Run target.
.TP
\fBosdk-debug\fR(1)
\fBcutekit-debug\fR(1)
Debug target.
.TP
\fBosdk-build\fR(1)
\fBcutekit-build\fR(1)
Build target.
.TP
\fBosdk-clean\fR(1)
\fBcutekit-clean\fR(1)
Clean the build directory.
.TP
\fBosdk-nuke\fR(1)
\fBcutekit-nuke\fR(1)
Clean the build directory and cache.
.SS Manifest Commands
.TP
\fBosdk-list\fR(1)
\fBcutekit-list\fR(1)
List existing targets.
.TP
\fBosdk-graph\fR(1)
\fBcutekit-graph\fR(1)
Show dependency graph.
.SS "Package Commands"
.TP
\fBosdk-install\fR(1)
\fBcutekit-install\fR(1)
Install all the external packages.
.TP
\fBosdk-init\fR(1)
\fBcutekit-init\fR(1)
Start a new project.
.SS General Commands
.TP
\fBosdk-help\fR(1)
\fBcutekit-help\fR(1)
Display help information.
.TP
\fBosdk-version\fR(1)
\fBcutekit-version\fR(1)
Display current version and exit.

.SH EXIT STATUS
exits with status 0 if all operations were successfull, greater than 0 if
errors occur.

.SH BUGS
See <https://github.com/cute-engineering/osdk> for issues.
See <https://github.com/cute-engineering/cutekit> for issues.

.SH EXAMPLES
.TP
Install and build a project
osdk install
cutekit install
.br
osdk build
cutekit build

.SH COPYRIGHT
Copyright \(co 2023 Cute Engineering.
Expand Down

0 comments on commit 971fe5a

Please sign in to comment.