> For the complete documentation index, see [llms.txt](https://docs.bfren.dev/docker/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.bfren.dev/docker/alpine-s6/executables.md). # Alpine S6: Executables ## Output ### bf-svc-finish Outputs service closing down debug message and optionally terminates *all* running services. Usually used in `/etc/services.d/xxx/finish` file to show #### Arguments * `-s X` outputs a message that service "X" is shutting down * `-t` terminates all other services as well #### Usage ```bash $ bf-svc-finish -s cron [bf] 2021-09-23 10:21:52 | cron/finish: Service closing down. $ bf-svc-finish -s cron -t [bf] 2021-09-19 18:00:00 | cron/finish: Service closing down. [bf] 2021-09-19 18:00:00 | bf-env: BF_TERMINATING=1. [bf] 2021-09-19 18:00:00 | bf-svc-terminate: Terminating all services. [bf] 2021-09-19 18:00:00 | cron-log/finish: Service closing down. [cont-finish.d] executing container finish scripts... [cont-finish.d] 00-clear: executing... [bf] 2021-09-19 18:00:00 | 00-clear: Clearing /tmp... (bf-clear) [bf] 2021-09-19 18:00:00 | 00-clear: done. (bf-clear) [bf] 2021-09-19 18:00:00 | 00-clear: Clearing caches... (bf-clear) [bf] 2021-09-19 18:00:00 | 00-clear: done. (bf-clear) [cont-finish.d] 00-clear: exited 0. [cont-finish.d] done. [s6-finish] waiting for services. [s6-finish] sending all processes the TERM signal. [s6-finish] sending all processes the KILL signal and exiting. ``` ## Helpers ### bf-clear-src Clears contents of `/etc/bf/src`. #### Usage ```bash $ bf-clear-src [bf] 2021-09-19 18:00:00 | bf-clear-src: Clearing /etc/bf/src... [bf] 2021-09-19 18:00:00 | bf-clear-src: done. ``` ### bf-cron Run all scripts within a cron directory. #### Arguments * -h Show usage * -q Run quietly (otherwise it will output that the cron is being run to the logs - individual scripts may still send output) * DIRECTORY - the directory within `/etc/periodic` to run #### Usage ``` $ bf-cron 1min [bf] 2021-09-19 18:00:00 | bf-cron: /etc/periodic/1min. $ bf-cron -q 1min // scripts are run with no output ``` ### bf-env Adds a container environment variable called `$1` with value `$2`. #### Arguments 1. Variable name 2. Variable value #### Usage ```bash $ bf-env "DOCS" "Docker Docs" [bf] 2021-09-19 18:00:00 | bf-env: DOCS=Docker Docs. ``` ### bf-fix-attrs Re-applies attributes and permissions defined in `/etc/fix-attrs.d`. Based on code from [S6 Overlay](https://github.com/just-containers/s6-overlay/blob/master/builder/overlay-rootfs/etc/s6/init/init-stage2). #### Usage ```bash $ bf-fix-attrs [bf] 2021-09-19 18:00:00 | bf-fixattrs: Applying ownership & permissions fixes... [bf] 2021-09-19 18:00:00 | bf-fixattrs: 00-alpine-s6: applying... [bf] 2021-09-19 18:00:00 | bf-fixattrs: 00-alpine-s6: exited 0. [bf] 2021-09-19 18:00:00 | bf-fixattrs: done. ``` ### bf-forward Forwards errors logged in `$2` to Docker logs; if `$2` is not set, disables service `$1`. #### Arguments 1. Service name. 2. Absolute path to log file. #### Usage ```bash $ bf-forward cron-log /var/log/cron.log [bf] 2021-09-19 18:00:00 | [bf] 2021-09-23 09:57:59 | cron-log/run: Forwarding cron-log - /var/log/cron.log. (bf-forward) ``` ### bf-svc Uses S6 to control the service named `$2`. #### Arguments 1. Control action: 'disable', 'restart', 'start', 'stop' 2. Service name #### Usage ```bash $ bf-svc restart cron [bf] 2021-09-19 18:00:00 | bf-svc: Restarting service 'cron'. [bf] 2021-09-19 18:00:00 | cron/finish: Service closing down. [bf] 2021-09-19 18:00:00 | cron/run: Starting cron. crond: crond (busybox 1.33.1) started, log level 8 ``` ### bf-svc-terminate Terminates all running services - usually used in `/etc/services.d/xxx/finish` file - which also closes down (and potentially restarts) the whole container. #### Usage ```bash $ bf-svc-terminate [bf] 2021-09-19 18:00:00 | bf-env: BF_TERMINATING=1. [bf] 2021-09-19 18:00:00 | bf-svc-terminate: Terminating all services. [bf] 2021-09-19 18:00:00 | cron/finish: Service closing down. [bf] 2021-09-19 18:00:00 | cron-log/finish: Service closing down. [cont-finish.d] executing container finish scripts... [cont-finish.d] 00-clear: executing... [bf] 2021-09-19 18:00:00 | 00-clear: Clearing /tmp... (bf-clear) [bf] 2021-09-19 18:00:00 | 00-clear: done. (bf-clear) [bf] 2021-09-19 18:00:00 | 00-clear: Clearing caches... (bf-clear) [bf] 2021-09-19 18:00:00 | 00-clear: done. (bf-clear) [cont-finish.d] 00-clear: exited 0. [cont-finish.d] done. [s6-finish] waiting for services. [s6-finish] sending all processes the TERM signal. [s6-finish] sending all processes the KILL signal and exiting. ``` --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter: ``` GET https://docs.bfren.dev/docker/alpine-s6/executables.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.