diff --git a/documentation/content/en/books/porters-handbook/special/_index.adoc b/documentation/content/en/books/porters-handbook/special/_index.adoc --- a/documentation/content/en/books/porters-handbook/special/_index.adoc +++ b/documentation/content/en/books/porters-handbook/special/_index.adoc @@ -4431,6 +4431,50 @@ Do not count on an Xfce component to provide a sub-dependency other than itself for the main port. ==== +[[using-budgie]] +== Using Budgie + +Applications or libraries depending on the Budgie desktop should set `USES= budgie` and set `USE_BUDGIE` to the list of required components. + +[cols="1,1", frame="none", options="header"] +|=== +| Name +| Description + +| `libbudgie` +| Desktop core (library) + +| `raven` +| All-in-one center in panel for accessing different applications widgets + +| `screensaver` +| Desktop-specific screensaver + +|=== + +[NOTE] +==== +All application widgets communicate through the *org.budgie_desktop.Raven* service. + +The default dependency is lib- and run-time, it can be changed with `:build` or `:run`, for example: + +[.programlisting] +.... +USES= budgie +USE_BUDGIE= screensaver:build +.... +==== + +[[budgie-components-example]] +.`USE_BUDGIE` Example +[example] +==== +[.programlisting] +.... +USES= budgie gettext gnome meson pkgconfig +USE_BUDGIE= libbudgie +.... +==== [[using-databases]] == Using Databases diff --git a/documentation/content/en/books/porters-handbook/uses/_index.adoc b/documentation/content/en/books/porters-handbook/uses/_index.adoc --- a/documentation/content/en/books/porters-handbook/uses/_index.adoc +++ b/documentation/content/en/books/porters-handbook/uses/_index.adoc @@ -179,6 +179,15 @@ Uses package:devel/bison[] By default, with no arguments or with the `build` argument, it implies `bison` is a build-time dependency, `run` implies a run-time dependency, and `both` implies both run-time and build-time dependencies. +[[uses-budgie]] +== `budgie` + +Possible arguments: (none) + +Provide support for the Budgie desktop environment. +Use `USE_BUDGIE` to select the components needed for the port. +See crossref:special[using-budgie,Using Budgie] for more information. + [[uses-cabal]] == `cabal`