From patchwork Mon Feb 13 16:50:57 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Janneke Nieuwenhuizen X-Patchwork-Id: 46925 Return-Path: X-Original-To: patchwork@mira.cbaines.net Delivered-To: patchwork@mira.cbaines.net Received: by mira.cbaines.net (Postfix, from userid 113) id DE71F166B0; Mon, 13 Feb 2023 16:52:39 +0000 (GMT) X-Spam-Checker-Version: SpamAssassin 3.4.6 (2021-04-09) on mira.cbaines.net X-Spam-Level: X-Spam-Status: No, score=-3.7 required=5.0 tests=BAYES_00,DKIM_INVALID, DKIM_SIGNED,MAILING_LIST_MULTI,RCVD_IN_MSPIKE_H2,SPF_HELO_PASS, URIBL_BLOCKED autolearn=ham autolearn_force=no version=3.4.6 Received: from lists.gnu.org (lists.gnu.org [209.51.188.17]) by mira.cbaines.net (Postfix) with ESMTPS id C624016661 for ; Mon, 13 Feb 2023 16:52:38 +0000 (GMT) Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1pRc3j-00089T-60; Mon, 13 Feb 2023 11:52:07 -0500 Received: from eggs.gnu.org ([2001:470:142:3::10]) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1pRc3f-00088R-LV for guix-patches@gnu.org; Mon, 13 Feb 2023 11:52:04 -0500 Received: from debbugs.gnu.org ([209.51.188.43]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1pRc3f-0005aJ-CN for guix-patches@gnu.org; Mon, 13 Feb 2023 11:52:03 -0500 Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1pRc3f-0003yN-8R for guix-patches@gnu.org; Mon, 13 Feb 2023 11:52:03 -0500 X-Loop: help-debbugs@gnu.org Subject: [bug#61483] [PATCH 5/5] DRAFT doc: Document Home Shepherd Services. Resent-From: Janneke Nieuwenhuizen Original-Sender: "Debbugs-submit" Resent-CC: guix-patches@gnu.org Resent-Date: Mon, 13 Feb 2023 16:52:03 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: followup 61483 X-GNU-PR-Package: guix-patches X-GNU-PR-Keywords: patch To: 61483@debbugs.gnu.org Cc: Janneke Nieuwenhuizen Received: via spool by 61483-submit@debbugs.gnu.org id=B61483.167630708215192 (code B ref 61483); Mon, 13 Feb 2023 16:52:03 +0000 Received: (at 61483) by debbugs.gnu.org; 13 Feb 2023 16:51:22 +0000 Received: from localhost ([127.0.0.1]:51353 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1pRc2z-0003ws-Gf for submit@debbugs.gnu.org; Mon, 13 Feb 2023 11:51:21 -0500 Received: from eggs.gnu.org ([209.51.188.92]:43238) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1pRc2r-0003vr-MA for 61483@debbugs.gnu.org; Mon, 13 Feb 2023 11:51:14 -0500 Received: from fencepost.gnu.org ([2001:470:142:3::e]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1pRc2m-0005Sn-Ex; Mon, 13 Feb 2023 11:51:08 -0500 DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=gnu.org; s=fencepost-gnu-org; h=MIME-Version:References:In-Reply-To:Date:Subject:To: From; bh=t8GkcjUURTlShaI9qYZ+NUQdttLUSINbllF4bssTXB8=; b=Kyc6O6tw0Gd5aSkz/Fst euH8PYoT1Un8Zu6kikL2arPZr0yXc3gK+tegXDEHOXaGUnwtl4X6nre2wYiOoFDyJeCD8GOtvnYTv WIYdoBVaRGyGonjk+yMAYX1ViN5xWrt3Gv0qb6aynNPupTmjmE3zpaD3EfVznjxqsMEGdK2nzWW0y U2gNw2zIYR445pxBYQz+nxW0YOmLgHCjjCvcJ3itMDztcjabLIOQ1oGEJx6EL0qI1pb7WNolVnhPe GVBKumFv9+hY587XAdLv/AT4LyTCc+pn8EbeNt97Hg1rhl88kxEws5sM2lzVgdUFARKQ+dLC5hF36 jiYbIkMvTdOSLA==; Received: from 2a02-a462-da03-1-2701-7f81-a736-4607.fixed6.kpn.net ([2a02:a462:da03:1:2701:7f81:a736:4607] helo=drakenpad.fritz.box) by fencepost.gnu.org with esmtpa (Exim 4.90_1) (envelope-from ) id 1pRc2l-0001Mq-SH; Mon, 13 Feb 2023 11:51:08 -0500 From: Janneke Nieuwenhuizen Date: Mon, 13 Feb 2023 17:50:57 +0100 Message-Id: <20230213165057.24518-5-janneke@gnu.org> X-Mailer: git-send-email 2.38.1 In-Reply-To: <20230213165057.24518-1-janneke@gnu.org> References: <20230213165057.24518-1-janneke@gnu.org> MIME-Version: 1.0 X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.18 Precedence: list X-BeenThere: guix-patches@gnu.org List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: guix-patches-bounces+patchwork=mira.cbaines.net@gnu.org Sender: guix-patches-bounces+patchwork=mira.cbaines.net@gnu.org X-getmail-retrieved-from-mailbox: Patches From: "Janneke Nieuwenhuizen" * doc/guix.texi (Shepherd Home Services): New subsubsection. --- doc/guix.texi | 90 ++++++++++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 89 insertions(+), 1 deletion(-) diff --git a/doc/guix.texi b/doc/guix.texi index 784114f0bb..04ce076784 100644 --- a/doc/guix.texi +++ b/doc/guix.texi @@ -36,7 +36,7 @@ Copyright @copyright{} 2016, 2017, 2018, 2021 Chris Marusich@* Copyright @copyright{} 2016, 2017, 2018, 2019, 2020, 2021, 2022 Efraim Flashner@* Copyright @copyright{} 2016 John Darrington@* Copyright @copyright{} 2016, 2017 Nikita Gillmann@* -Copyright @copyright{} 2016, 2017, 2018, 2019, 2020 Jan Nieuwenhuizen@* +Copyright @copyright{} 2016, 2017, 2018, 2019, 2020, 2023 Jan Nieuwenhuizen@* Copyright @copyright{} 2016, 2017, 2018, 2019, 2020, 2021 Julien Lepiller@* Copyright @copyright{} 2016 Alex ter Weele@* Copyright @copyright{} 2016, 2017, 2018, 2019, 2020, 2021 Christopher Baines@* @@ -41285,6 +41285,94 @@ mechanism instead (@pxref{Shepherd Services}). @end table @end deftp +@menu +* Shepherd Home Services:: +@end menu + +@node Shepherd Home Services +@subsubsection e Shepherd Home Services + +The @code{(gnu home services shepherd-xyz)} module provides serveral +home shepherd services. + +@defvr {Scheme Variable} home-git-daemon-service-type +This is the type of the @code{git daemon} home service, whose value is an +@code{home-git-daemon-configuration} object. +@end defvr + +@deftp {Data Type} home-git-daemon-configuration +Available @code{home-git-daemon-configuration} fields are: + +@table @asis +@item @code{git} (default: @code{git}) (type: file-like) +The git package to use. + +@item @code{root} (default: @code{"~/git-daemon"}) (type: string) +The git deamon's base directory. + +@item @code{log-dir} (default: @code{@env{XDG_CONFIG_HOME}/shepherd"}) (type: string) +The directory to write the @file{git-daemon.log} file. + +@end table +@end deftp + +@defvr {Scheme Variable} home-kodi-service-type +This is the type of the @code{git daemon} home service, whose value is an +@code{home-kodi-configuration} object. +@end defvr + +@deftp {Data Type} home-kodi-configuration +Available @code{home-kodi-configuration} fields are: + +@table @asis +@item @code{git} (default: @code{git}) (type: file-like) +The git package to use. + +@item @code{log-dir} (default: @code{@env{XDG_CONFIG_HOME}/shepherd"}) (type: string) +The directory to write the @file{kodi.log} file. + +@end table +@end deftp + +@defvr {Scheme Variable} home-ssh-agent-service-type +This is the type of the @code{git daemon} home service, whose value is an +@code{home-ssh-agent-configuration} object. +@end defvr + +@deftp {Data Type} home-ssh-agent-configuration +Available @code{home-ssh-agent-configuration} fields are: + +@table @asis +@item @code{git} (default: @code{git}) (type: file-like) +The git package to use. + +@item @code{socket-dir} (default: @code{@env{XDG_RUNTIME_DIR}/ssh-agent"}) (type: string) +The directory to write the ssh-agent's @file{socket} file. + +@item @code{log-dir} (default: @code{@env{XDG_CONFIG_HOME}/shepherd"}) (type: string) +The directory to write the @file{ssh-agent.log} file. + +@end table +@end deftp + +@defvr {Scheme Variable} home-znc-service-type +This is the type of the @code{git daemon} home service, whose value is an +@code{home-znc-configuration} object. +@end defvr + +@deftp {Data Type} home-znc-configuration +Available @code{home-znc-configuration} fields are: + +@table @asis +@item @code{git} (default: @code{git}) (type: file-like) +The git package to use. + +@item @code{log-dir} (default: @code{@env{XDG_CONFIG_HOME}/shepherd"}) (type: string) +The directory to write the @file{znc.log} file. + +@end table +@end deftp + @node Secure Shell @subsection Secure Shell