Skip to content

Commit

Permalink
man: Regen documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
joebonrichie committed Sep 15, 2024
1 parent 6749518 commit bfb4599
Show file tree
Hide file tree
Showing 9 changed files with 121 additions and 142 deletions.
148 changes: 72 additions & 76 deletions man/package.yml.5

Large diffs are not rendered by default.

15 changes: 3 additions & 12 deletions man/package.yml.5.html

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

10 changes: 1 addition & 9 deletions man/package.yml.5.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
package.yml(5) -- Solus package build format
==========================================

## SYNOPSIS

The Solus package build format, with YAML syntax.
Expand Down Expand Up @@ -308,14 +308,6 @@ additional functionality.
gzip files. Only enable when it significantly reduces the installed
size of a package on disk without sacrificing eopkg size too much.

* `fatfakeroot` [boolean]

By default, this key is disabled. By default, fakeroot is only enabled for the
"install" and "check" steps due to it's massive performance overhead. Enabling,
this key will enable fakeroot for all build stages. You may want to enable this
if you are experiencing strange "Permission Denied" errors in the "build" stage,
or when rebuilding a reverse dependency against a package.

* `debug` [boolean]

By default, this key is enabled, and as a result `ypkg-build(1)` will
Expand Down
24 changes: 12 additions & 12 deletions man/ypkg-build.1
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
.\" generated with Ronn-NG/v0.9.1
.\" http://github.com/apjanke/ronn-ng/tree/0.9.1
.TH "YPKG\-BUILD" "1" "October 2023" ""
.\" generated with Ronn-NG/v0.10.1
.\" http://github.com/apjanke/ronn-ng/tree/0.10.1
.TH "YPKG\-BUILD" "1" "September 2024" ""
.SH "NAME"
\fBypkg\-build\fR \- Build Solus ypkg files
.SH "SYNOPSIS"
Expand All @@ -13,47 +13,47 @@ For details on the package format itself, please refer to the \fBpackage\.yml(5)
Note that you should not use \fBypkg\-build(1)\fR directly unless completely unavoidable\. Instead, you should be using \fBsolbuild(1)\fR for isolated build environments\.
.SH "OPTIONS"
The following options are applicable to \fBypkg\-build(1)\fR\.
.IP "\[ci]" 4
.IP "\(bu" 4
\fB\-h\fR, \fB\-\-help\fR
.IP
Print the command line options for \fBypkg(1)\fR and exit\.
.IP "\[ci]" 4
.IP "\(bu" 4
\fB\-v\fR, \fB\-\-version\fR
.IP
Print the \fBypkg(1)\fR version and exit\.
.IP "\[ci]" 4
.IP "\(bu" 4
\fB\-n\fR, \fB\-\-no\-colors\fR
.IP
Disable text colourisation in the output from \fBypkg\fR and all child processes\.
.IP "\[ci]" 4
.IP "\(bu" 4
\fB\-t\fR, \fB\-\-timestamp\fR
.IP
This argument should be a UNIX timestamp, and will be used to set the file timestamps inside the final \fB\.eopkg\fR archive, as well as the container files within that archive\.
.IP
Using this option helps achieve a level of reproducability in builds, and this option is passed by \fBsolbuild(1)\fR automatically for ypkg builds\. It will examine the git history and use the UTC UNIX timestamp for the last tag, ensuring the package can be built by any machine using \fBsolbuild(1)\fR and result in an identical package, byte for byte\.
.IP "\[ci]" 4
.IP "\(bu" 4
\fB\-D\fR, \fB\-\-output\-dir\fR
.IP
Set the output directory for \fBypkg\-build(1)\fR
.IP "" 0
.SH "EXIT STATUS"
On success, 0 is returned\. A non\-zero return code signals a failure\.
.SH "COPYRIGHT"
.IP "\[ci]" 4
.IP "\(bu" 4
Copyright \(co 2016\-2020 Solus Project
.IP "" 0
.P
Released under the terms of the CC\-BY\-SA\-3\.0 license
.SH "SEE ALSO"
\fBsolbuild(1)\fR, \fBypkg\-install\-deps(1)\fR, \fBypkg(1)\fR, \fBpackage\.yml(5)\fR
.IP "\[ci]" 4
.IP "\(bu" 4
https://github\.com/getsolus/ypkg
.IP "\[ci]" 4
.IP "\(bu" 4
https://getsol\.us/articles/packaging
.IP "" 0
.SH "NOTES"
Creative Commons Attribution\-ShareAlike 3\.0 Unported
.IP "\[ci]" 4
.IP "\(bu" 4
http://creativecommons\.org/licenses/by\-sa/3\.0/
.IP "" 0

6 changes: 3 additions & 3 deletions man/ypkg-build.1.html

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

24 changes: 12 additions & 12 deletions man/ypkg-install-deps.1
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
.\" generated with Ronn-NG/v0.9.1
.\" http://github.com/apjanke/ronn-ng/tree/0.9.1
.TH "YPKG\-INSTALL\-DEPS" "1" "October 2023" ""
.\" generated with Ronn-NG/v0.10.1
.\" http://github.com/apjanke/ronn-ng/tree/0.10.1
.TH "YPKG\-INSTALL\-DEPS" "1" "September 2024" ""
.SH "NAME"
\fBypkg\-install\-deps\fR \- Install build dependencies
.SH "SYNOPSIS"
Expand All @@ -9,45 +9,45 @@
\fBypkg\-install\-deps\fR will install all of the build dependencies listed in the given \fBpackage\.yml(5)\fR file\. Note that resolution of \fBpkgconfig\fR and \fBpkgconfig32\fR dependencies is handled automatically\.
.SH "OPTIONS"
The following options are applicable to \fBypkg\-install\-deps(1)\fR\.
.IP "\[ci]" 4
.IP "\(bu" 4
\fB\-h\fR, \fB\-\-help\fR
.IP
Print the command line options for \fBypkg(1)\fR and exit\.
.IP "\[ci]" 4
.IP "\(bu" 4
\fB\-v\fR, \fB\-\-version\fR
.IP
Print the \fBypkg(1)\fR version and exit\.
.IP "\[ci]" 4
.IP "\(bu" 4
\fB\-n\fR, \fB\-\-no\-colors\fR
.IP
Disable text colourisation in the output from \fBypkg\fR and all child processes\.
.IP "\[ci]" 4
.IP "\(bu" 4
\fB\-D\fR, \fB\-\-output\-dir\fR
.IP
This option is ignored by \fBypkg\-install\-deps(1)\fR\. It is provided simply for compatibility in scripting to allow \fBypkg(1)\fR to pass arguments forward for the duration of the session\.
.IP "\[ci]" 4
.IP "\(bu" 4
\fB\-f\fR, \fB\-\-force\fR
.IP
Force the installation of package dependencies, which will bypass any prompting by ypkg\. The default behaviour is to prompt before installing packages\.
.IP "" 0
.SH "EXIT STATUS"
On success, 0 is returned\. A non\-zero return code signals a failure\.
.SH "COPYRIGHT"
.IP "\[ci]" 4
.IP "\(bu" 4
Copyright \(co 2016\-2020 Solus Project
.IP "" 0
.P
Released under the terms of the CC\-BY\-SA\-3\.0 license
.SH "SEE ALSO"
\fBsolbuild(1)\fR, \fBypkg(1)\fR \fBypkg\-build(1)\fR, \fBpackage\.yml(5)\fR
.IP "\[ci]" 4
.IP "\(bu" 4
https://github\.com/getsolus/ypkg
.IP "\[ci]" 4
.IP "\(bu" 4
https://getsol\.us/articles/packaging
.IP "" 0
.SH "NOTES"
Creative Commons Attribution\-ShareAlike 3\.0 Unported
.IP "\[ci]" 4
.IP "\(bu" 4
http://creativecommons\.org/licenses/by\-sa/3\.0/
.IP "" 0

6 changes: 3 additions & 3 deletions man/ypkg-install-deps.1.html

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

24 changes: 12 additions & 12 deletions man/ypkg.1
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
.\" generated with Ronn-NG/v0.9.1
.\" http://github.com/apjanke/ronn-ng/tree/0.9.1
.TH "YPKG" "1" "October 2023" ""
.\" generated with Ronn-NG/v0.10.1
.\" http://github.com/apjanke/ronn-ng/tree/0.10.1
.TH "YPKG" "1" "September 2024" ""
.SH "NAME"
\fBypkg\fR \- Build Solus ypkg files
.SH "SYNOPSIS"
Expand All @@ -11,45 +11,45 @@
Note that you should not use \fBypkg(1)\fR directly unless completely unavoidable\. Instead, you should be using \fBsolbuild(1)\fR for isolated build environments\.
.SH "OPTIONS"
The following options are applicable to \fBypkg(1)\fR\.
.IP "\[ci]" 4
.IP "\(bu" 4
\fB\-h\fR, \fB\-\-help\fR
.IP
Print the command line options for \fBypkg(1)\fR and exit\.
.IP "\[ci]" 4
.IP "\(bu" 4
\fB\-v\fR, \fB\-\-version\fR
.IP
Print the \fBypkg(1)\fR version and exit\.
.IP "\[ci]" 4
.IP "\(bu" 4
\fB\-n\fR, \fB\-\-no\-colors\fR
.IP
Disable text colourisation in the output from \fBypkg\fR and all child processes\.
.IP "\[ci]" 4
.IP "\(bu" 4
\fB\-D\fR, \fB\-\-output\-dir\fR
.IP
Set the output directory for \fBypkg\-build(1)\fR
.IP "\[ci]" 4
.IP "\(bu" 4
\fB\-f\fR, \fB\-\-force\fR
.IP
Force the installation of package dependencies, which will bypass any prompting by ypkg\. The default behaviour is to prompt before installing packages\.
.IP "" 0
.SH "EXIT STATUS"
On success, 0 is returned\. A non\-zero return code signals a failure\.
.SH "COPYRIGHT"
.IP "\[ci]" 4
.IP "\(bu" 4
Copyright \(co 2016\-2020 Solus Project
.IP "" 0
.P
Released under the terms of the CC\-BY\-SA\-3\.0 license
.SH "SEE ALSO"
\fBsolbuild(1)\fR, \fBypkg\-install\-deps(1)\fR, \fBypkg\-build(1)\fR, \fBpackage\.yml(5)\fR
.IP "\[ci]" 4
.IP "\(bu" 4
https://github\.com/getsolus/ypkg
.IP "\[ci]" 4
.IP "\(bu" 4
https://getsol\.us/articles/packaging
.IP "" 0
.SH "NOTES"
Creative Commons Attribution\-ShareAlike 3\.0 Unported
.IP "\[ci]" 4
.IP "\(bu" 4
http://creativecommons\.org/licenses/by\-sa/3\.0/
.IP "" 0

6 changes: 3 additions & 3 deletions man/ypkg.1.html

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit bfb4599

Please sign in to comment.