.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.43) .\" .\" Standard preamble: .\" ======================================================================== .de Sp \" Vertical space (when we can't use .PP) .if t .sp .5v .if n .sp .. .de Vb \" Begin verbatim text .ft CW .nf .ne \\$1 .. .de Ve \" End verbatim text .ft R .fi .. .\" Set up some character translations and predefined strings. \*(-- will .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left .\" double quote, and \*(R" will give a right double quote. \*(C+ will .\" give a nicer C++. Capital omega is used to do unbreakable dashes and .\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff, .\" nothing in troff, for use with C<>. .tr \(*W- .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' .ie n \{\ . ds -- \(*W- . ds PI pi . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch . ds L" "" . ds R" "" . ds C` "" . ds C' "" 'br\} .el\{\ . ds -- \|\(em\| . ds PI \(*p . ds L" `` . ds R" '' . ds C` . ds C' 'br\} .\" .\" Escape single quotes in literal strings from groff's Unicode transform. .ie \n(.g .ds Aq \(aq .el .ds Aq ' .\" .\" If the F register is >0, we'll generate index entries on stderr for .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index .\" entries marked with X<> in POD. Of course, you'll have to process the .\" output yourself in some meaningful fashion. .\" .\" Avoid warning from groff about undefined register 'F'. .de IX .. .nr rF 0 .if \n(.g .if rF .nr rF 1 .if (\n(rF:(\n(.g==0)) \{\ . if \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{\ . nr % 0 . nr F 2 . \} . \} .\} .rr rF .\" .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). .\" Fear. Run. Save yourself. No user-serviceable parts. . \" fudge factors for nroff and troff .if n \{\ . ds #H 0 . ds #V .8m . ds #F .3m . ds #[ \f1 . ds #] \fP .\} .if t \{\ . ds #H ((1u-(\\\\n(.fu%2u))*.13m) . ds #V .6m . ds #F 0 . ds #[ \& . ds #] \& .\} . \" simple accents for nroff and troff .if n \{\ . ds ' \& . ds ` \& . ds ^ \& . ds , \& . ds ~ ~ . ds / .\} .if t \{\ . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' .\} . \" troff and (daisy-wheel) nroff accents .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V' .ds 8 \h'\*(#H'\(*b\h'-\*(#H' .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#] .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H' .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u' .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#] .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#] .ds ae a\h'-(\w'a'u*4/10)'e .ds Ae A\h'-(\w'A'u*4/10)'E . \" corrections for vroff .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u' .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u' . \" for low resolution devices (crt and lpr) .if \n(.H>23 .if \n(.V>19 \ \{\ . ds : e . ds 8 ss . ds o a . ds d- d\h'-1'\(ga . ds D- D\h'-1'\(hy . ds th \o'bp' . ds Th \o'LP' . ds ae ae . ds Ae AE .\} .rm #[ #] #H #V #F C .\" ======================================================================== .\" .IX Title "Config::Model::Systemd 3pm" .TH Config::Model::Systemd 3pm "2023-11-26" "perl v5.36.0" "User Contributed Perl Documentation" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l .nh .SH "NAME" Config::Model::Systemd \- Editor and validator for systemd configuration files .SH "VERSION" .IX Header "VERSION" version 0.254.1 .SH "SYNOPSIS" .IX Header "SYNOPSIS" .Vb 4 \& # run on one service: \& $ sudo cme systemd\-service # run command on name.service \& $ sudo cme systemd\-socket # run command on name.socket \& $ sudo cme systemd\-timer # run command on name.timer \& \& # run on several user units: \& # Run on several units: \& $ sudo cme systemd * # run command on all units \& $ sudo cme systemd # run command on all units matching pattern \& $ sudo cme systemd # run command on all units matching pattern \& \& $ cme systemd\-user # run command on all user units matching pattern \& \& # run on one service file (for unit development): \& $ sudo cme systemd\-service\-file \& $ sudo cme systemd\-socket\-file \& $ sudo cme systemd\-timer\-file .Ve .SH "DESCRIPTION" .IX Header "DESCRIPTION" This module provides (with cme) a configuration editor for the configuration files of systemd, i.e. all files in \&\f(CW\*(C`~/.config/systemd/user/\*(C'\fR or all files in \f(CW\*(C`/etc/systemd/system/\*(C'\fR .PP Ok. I simplified. In more details, this module provides the configuration models of Systemd configuration file that cme, Config::Model and Config::Model::TkUI use to provide a configuration editor (\f(CW\*(C`cme edit\*(C'\fR) and checker (\f(CW\*(C`cme check\*(C'\fR). .SS "invoke editor" .IX Subsection "invoke editor" The following command loads user systemd files (from \&\f(CW\*(C`~/.config/systemd/user/\*(C'\fR and launch a graphical editor: .PP .Vb 1 \& cme edit systemd\-user foo .Ve .PP Likewise, the following command loads system systemd configuration files and launch a graphical editor to updated an override file (like \&\f(CW\*(C`systemctl edit\*(C'\fR command): .PP .Vb 1 \& sudo cme edit systemd foo .Ve .PP A developer can also edit a systemd file shipped with a software: .PP .Vb 1 \& cme edit systemd\-service\-file software\-thing.service .Ve .SS "Just check systemd configuration" .IX Subsection "Just check systemd configuration" You can also use cme to run sanity checks on systemd configuration files: .PP .Vb 4 \& cme check systemd\-user \*(Aq*\*(Aq \& cme check systemd \*(Aq*\*(Aq # may take time \& cme check systemd\-service foo \& cme check systemd\-service\-file software\-thing.service .Ve .SS "Use in Perl program (experimental)" .IX Subsection "Use in Perl program (experimental)" As of Config::Model 2.086, a \*(L"cme(...)\*(R" in cme function is exported to modify configuration in a Perl program. For instance: .PP .Vb 6 \& use Config::Model qw/cme/; # also import cme function \& # call cme for systemd\-user, modify ans save my\-imap\-tunnel.socket file. \& cme( \& application => \*(Aqsystemd\-user\*(Aq, \& backend_arg => \*(Aqmy\-imap\-tunnel\*(Aq \& )\->modify(\*(Aqsocket:my\-imap\-tunnel Socket Accept=yes\*(Aq) ; .Ve .PP Similarly, system Systemd files can be modified using \f(CW\*(C`systemd\*(C'\fR application: .PP .Vb 5 \& use Config::Model qw/cme/; \& cme( \& application => \*(Aqsystemd\*(Aq, \& backend_arg => \*(Aqfoo\*(Aq \& )\->modify(...) ; .Ve .PP For more details and parameters, please see cme, modify, load and save documentation. .SH "Command line example" .IX Header "Command line example" The examples below require App::Cme .PP Dump override content of a specific service: .PP .Vb 11 \& $ cme dump systemd\-service transmission\-daemon \& Reading unit \*(Aqservice\*(Aq \*(Aqtransmission\-daemon\*(Aq from \*(Aq/lib/systemd/system/transmission\-daemon.service\*(Aq. \& \-\-\- \& Unit: \& After: \& \- network\-online.target \& \- remote\-fs.target \& Before: \& \- umount.target \& Conflicts: \& \- umount.target .Ve .PP Dump the whole service (like \f(CW\*(C`systemctl cat\*(C'\fR): .PP .Vb 10 \& $ cme dump systemd\-service transmission\-daemon \-\-dumptype full \& Reading unit \*(Aqservice\*(Aq \*(Aqtransmission\-daemon\*(Aq from \*(Aq/lib/systemd/system/transmission\-daemon.service\*(Aq. \& \-\-\- \& Install: \& WantedBy: \& \- multi\-user.target \& Service: \& CPUShares: 1024 \& CPUWeight: 100 \& ExecReload: \& \- /bin/kill \-s HUP $MAINPID \& ExecStart: \& \- /usr/bin/transmission\-daemon \-f \-\-log\-error \& [etc...] .Ve .PP Edit the service override with a \s-1GUI:\s0 .PP .Vb 1 \& $ cme edit systemd\-service transmission\-daemon.service .Ve .PP Edit the service override with a Shell \s-1UI:\s0 .PP .Vb 10 \& $ cme shell systemd\-service transmission\-daemon.service \& >:$ ls \& Service Unit Install \& >:$ cd Unit \& >: Unit $ ll \-nz \& name X type X value \& XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX \& Conflicts X list X umount.target \& Before X list X umount.target \& After X list X network\-online.target,remote\-fs.target \& >: Unit $ set After:.push(foo.target) \& >: Unit $ ll \-nz \& name X type X value \& XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX \& Conflicts X list X umount.target \& Before X list X umount.target \& After X list X network\-online.target,remote\-fs.target,foo.target .Ve .PP Run command all user units: .PP .Vb 2 \& $ cme edit systemd\-user \*(Aq*\*(Aq \& $ cme check systemd\-user \*(Aq*\*(Aq .Ve .PP Run command all user units that match 'foo': .PP .Vb 2 \& $ cme edit systemd\-user foo \& $ cme check systemd\-user foo .Ve .PP Check all root units (can be quite long on small systems): .PP .Vb 1 \& # cme check systemd \*(Aq*\*(Aq .Ve .PP Check all root units that match 'foo': .PP .Vb 1 \& # cme check systemd foo .Ve .PP Edit override file of \f(CW\*(C`foo.service\*(C'\fR: .PP .Vb 1 \& # cme edit systemd foo.service .Ve .PP Run command on a service file: .PP .Vb 2 \& $ cme check systemd\-service path/to/file.service \& $ cme edit systemd\-service path/to/file.service .Ve .PP Timer and socket units are also supported: .PP .Vb 2 \& $ cme check systemd\-socket path/to/file.socket \& $ cme check systemd\-timer path/to/file.timer .Ve .SS "Perl program (experimental)" .IX Subsection "Perl program (experimental)" .Vb 3 \& use Config::Model qw/cme/; \& cme(application => \*(Aqsystemd\-user\*(Aq backend_arg => \*(Aqfree\-imap\-tunnel\*(Aq) \& \->modify(\*(Aqsocket:free\-imap\-tunnel Socket Accept=yes\*(Aq) ; \& \& cme(application => \*(Aqsystemd\-service\*(Aq, config_file => \*(Aqfoo.service\*(Aq) \& \->modify(\*(AqUnit Description="a service that does foo things"\*(Aq) .Ve .SH "BUGS" .IX Header "BUGS" The list of supported parameters is extracted from the xml documentation provided by systemd project. This list is expected to be rather complete. .PP The properties of these parameters are inferred from the description of the parameters and are probably less accurate. In case of errors, please log a bug . .SH "TODO" .IX Header "TODO" For now, only \f(CW\*(C`unit\*(C'\fR, \f(CW\*(C`socket\*(C'\fR and \f(CW\*(C`service\*(C'\fR files are supported. Please log a wishlist bug if you need other unit types to be supported. .SH "SUPPORT" .IX Header "SUPPORT" In case of issue, please log a bug on . .SH "Contributors" .IX Header "Contributors" .Vb 1 \& Mohammad S Anwar .Ve .PP Thanks for your contributions .SH "SEE ALSO" .IX Header "SEE ALSO" .IP "\(bu" 4 cme .IP "\(bu" 4 Config::Model .IP "\(bu" 4 .SH "AUTHOR" .IX Header "AUTHOR" Dominique Dumont .SH "COPYRIGHT AND LICENSE" .IX Header "COPYRIGHT AND LICENSE" This software is Copyright (c) 2008\-2022 by Dominique Dumont. .PP This is free software, licensed under: .PP .Vb 1 \& The GNU Lesser General Public License, Version 2.1, February 1999 .Ve .SH "SUPPORT" .IX Header "SUPPORT" .SS "Websites" .IX Subsection "Websites" The following websites have more information about this module, and may be of help to you. As always, in addition to those websites please use your favorite search engine to discover more resources. .IP "\(bu" 4 \&\s-1CPANTS\s0 .Sp The \s-1CPANTS\s0 is a website that analyzes the Kwalitee ( code metrics ) of a distribution. .Sp .IP "\(bu" 4 \&\s-1CPAN\s0 Testers .Sp The \s-1CPAN\s0 Testers is a network of smoke testers who run automated tests on uploaded \s-1CPAN\s0 distributions. .Sp .IP "\(bu" 4 \&\s-1CPAN\s0 Testers Matrix .Sp The \s-1CPAN\s0 Testers Matrix is a website that provides a visual overview of the test results for a distribution on various Perls/platforms. .Sp .IP "\(bu" 4 \&\s-1CPAN\s0 Testers Dependencies .Sp The \s-1CPAN\s0 Testers Dependencies is a website that shows a chart of the test results of all dependencies for a distribution. .Sp .SS "Bugs / Feature Requests" .IX Subsection "Bugs / Feature Requests" Please report any bugs or feature requests by email to \f(CW\*(C`ddumont at cpan.org\*(C'\fR, or through the web interface at . You will be automatically notified of any progress on the request by the system. .SS "Source Code" .IX Subsection "Source Code" The code is open to the world, and available for you to hack on. Please feel free to browse it and play with it, or whatever. If you want to contribute patches, please send me a diff or prod me to pull from your repository :) .PP .PP .Vb 1 \& git clone git://github.com/dod38fr/config\-model\-systemd.git .Ve