Skip to content

Commit

Permalink
Document environment variables in separate section
Browse files Browse the repository at this point in the history
  • Loading branch information
dspinellis committed Mar 9, 2024
1 parent c178d7a commit 6e303a8
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 11 deletions.
6 changes: 0 additions & 6 deletions src/ai_cli.5
Original file line number Diff line number Diff line change
Expand Up @@ -18,12 +18,6 @@ section of library's manual page.
Configuration files are searched and loaded in the order specified in
.BR ai_cli (7).
Entries in configuration files read later can override previous ones.
All entries can be overridden by supplying to a program's invocation
an environment variable named
\fCAI_CLI_\fIsection\fC_\fIoption\fR,
where dashes are replaced with underscores.
For example, an environment variable setting could be
\fCAI_CLI_prompt_gdb_user_1=Disable breakpoint 3\fP.

In general, system-wide configuration files are used to specify
default behaviors,
Expand Down
20 changes: 15 additions & 5 deletions src/ai_cli.7
Original file line number Diff line number Diff line change
Expand Up @@ -91,11 +91,15 @@ can be configured through the files and environment variables listed in the
section and the format documented in
.BR ai_cli (5).

.SH BUGS
.B ai_cli
will not work with programs that are linked statically with
.BR readline (3)
rather than using it as a shared library object.
.SH ENVIRONMENT VARIABLES
All configuration entries specified through
.BR ai_cli (5).
can be overridden by supplying to a program's
invocation an environment variable named
\fCAI_CLI_\fIsection\fC_\fIoption\fR,
where dashes are replaced with underscores.
For example, an environment variable setting could be
\fCAI_CLI_prompt_gdb_user_1=Disable breakpoint 3\fP.

.SH FILES
.IR /usr/share/ai-cli/config ,
Expand All @@ -111,6 +115,12 @@ configuration files.
.SH SEE ALSO
.BR ai_cli (5).

.SH BUGS
.B ai_cli
will not work with programs that are linked statically with
.BR readline (3)
rather than using it as a shared library object.

.SH AUTHOR
Diomidis Spinellis ([email protected])

Expand Down

0 comments on commit 6e303a8

Please sign in to comment.