diff mbox series

[Bug,debuginfod/28325] Add debuginfod.service manual page

Message ID CAJXA7qi40A94UniLXjYKjFo2mkfTkGEDxybuEhS16-JVjb9CLw@mail.gmail.com
State Committed
Headers
Series [Bug,debuginfod/28325] Add debuginfod.service manual page |

Commit Message

Noah Sanci June 3, 2022, 2:43 p.m. UTC 
  Hello,

Please find the debuginfod.service manual page patch attached.

Thanks
Noah
diff mbox series

Patch

From 88c355011a78b5030fefedd10630bc99cecaceb6 Mon Sep 17 00:00:00 2001
From: Noah Sanci <nsanci@redhat.com>
Date: Thu, 2 Jun 2022 14:26:46 -0400
Subject: [PATCH] Added debuginfod.service.8 manual page.

Signed-off-by: Noah Sanci <nsanci@redhat.com>
---
 doc/Makefile.am          |  2 +-
 doc/debuginfod.service.8 | 30 ++++++++++++++++++++++++++++++
 2 files changed, 31 insertions(+), 1 deletion(-)
 create mode 100644 doc/debuginfod.service.8

diff --git a/doc/Makefile.am b/doc/Makefile.am
index 32d1a2b8..db2506fd 100644
--- a/doc/Makefile.am
+++ b/doc/Makefile.am
@@ -27,7 +27,7 @@  if DEBUGINFOD
 if !LIBDEBUGINFOD
 notrans_dist_man7_MANS += debuginfod-client-config.7
 endif
-notrans_dist_man8_MANS += debuginfod.8
+notrans_dist_man8_MANS += debuginfod.8 debuginfod.service.8
 endif
 
 if LIBDEBUGINFOD
diff --git a/doc/debuginfod.service.8 b/doc/debuginfod.service.8
new file mode 100644
index 00000000..b22b7570
--- /dev/null
+++ b/doc/debuginfod.service.8
@@ -0,0 +1,30 @@ 
+'\"! tbl | nroff \-man
+'\" t macro stdmacro
+
+.TH DEBUGINFOD.SERVICE 8
+.SH NAME
+debuginfod.service \- debuginfo related information server for systemd
+
+.SH SYNOPSIS
+.B /usr/lib/systemd/system/debuginfod.service
+
+.SH DESCRIPTION
+\fBdebuginfod.service\fP integrates the debuginfod daemon with
+systemd, serving debuginfo-related artifacts over HTTP.
+The data is stored in /var/cache/debuginfod/debuginfod.sqlite.
+Configure /etc/sysconfig/debuginfod to set the below environment
+variables as well as those listed in \fBdebuginfod\fP(8).
+.SH Environment variables
+\fB$DEBUGINFOD_PORT\fP - Changes port of \fBdebuginfod\fP service
+daemon.
+.br
+\fB$DEBUGINFOD_VERBOSE\fP - Change verbosity of reporting in
+\fBdebuginfod\fP service daemon log file.
+.br
+\fB$DEBUGINFOD_PATHS\fP - Changes paths to scan for \fBdebuginfod\fP service daemon.
+.SH FILES
+/usr/lib/systemd/system/debuginfod.service, /var/cache/debuginfod/debuginfod.sqlite
+/etc/sysconfig/debuginfod
+
+.SH SEE ALSO
+debuginfod(8), debuginfod-find(1), systemctl(1), systemd.service(5)
-- 
2.36.1