shaba/systemd
1
0
Fork 0
mirror of https://github.com/systemd/systemd.git synced 2024-12-22 17:35:35 +03:00
Code
2962a50850
systemd/man/systemd-tty-ask-password-agent.xml

139 lines
4.7 KiB
XML
Raw Normal View History

man: document tty-ask-password-agent
2012-06-27 04:12:39 +04:00
<?xml version='1.0'?> <!--*-nxml-*-->
man: use same header for all files The "include" files had type "book" for some raeason. I don't think this is meaningful. Let's just use the same everywhere. $ perl -i -0pe 's^..DOCTYPE (book|refentry) PUBLIC "-//OASIS//DTD DocBook XML V4.[25]//EN"\s+"http^<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"\n "http^gms' man/*.xml
2019-03-14 16:40:58 +03:00
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
man: revert dynamic paths for split-usr setups This did not really work out as we had hoped. Trying to do this upstream introduced several problems that probably makes it better suited as a downstream patch after all. At any rate, it is not releaseable in the current state, so we at least need to revert this before the release. * by adjusting the path to binaries, but not do the same thing to the search path we end up with inconsistent man-pages. Adjusting the search path too would be quite messy, and it is not at all obvious that this is worth the effort, but at any rate it would have to be done before we could ship this. * this means that distributed man-pages does not make sense as they depend on config options, and for better or worse we are still distributing man pages, so that is something that definitely needs sorting out before we could ship with this patch. * we have long held that split-usr is only minimally supported in order to boot, and something we hope will eventually go away. So before we start adding even more magic/effort in order to make this work nicely, we should probably question if it makes sense at all.
2015-06-18 20:47:44 +03:00
"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
license: LGPL-2.1+ -> LGPL-2.1-or-later
2020-11-09 07:23:58 +03:00
<!-- SPDX-License-Identifier: LGPL-2.1-or-later -->
man: document tty-ask-password-agent
2012-06-27 04:12:39 +04:00
man: xinclude --help/--version/--no-pager
2014-02-13 23:33:51 +04:00
<refentry id="systemd-tty-ask-password-agent"
Reindent man pages to 2ch
2015-02-04 05:14:13 +03:00
xmlns:xi="http://www.w3.org/2001/XInclude">
<refentryinfo>
<title>systemd-tty-ask-password-agent</title>
<productname>systemd</productname>
</refentryinfo>
<refmeta>
<refentrytitle>systemd-tty-ask-password-agent</refentrytitle>
<manvolnum>1</manvolnum>
</refmeta>
<refnamediv>
<refname>systemd-tty-ask-password-agent</refname>
<refpurpose>List or process pending systemd password requests</refpurpose>
</refnamediv>
<refsynopsisdiv>
<cmdsynopsis>
man: add more links to systemd-ask-password and systemd-tty-ask-password-agent Loosely inspired by https://bugzilla.redhat.com/show_bug.cgi?id=1411134.
2017-01-09 21:51:06 +03:00
<command>systemd-tty-ask-password-agent</command>
<arg choice="opt" rep="repeat">OPTIONS</arg>
<arg choice="opt" rep="repeat">VARIABLE=VALUE</arg>
Reindent man pages to 2ch
2015-02-04 05:14:13 +03:00
</cmdsynopsis>
</refsynopsisdiv>
<refsect1>
<title>Description</title>
<para><command>systemd-tty-ask-password-agent</command> is a
password agent that handles password requests of the system, for
example for hard disk encryption passwords or SSL certificate
passwords that need to be queried at boot-time or during
runtime.</para>
<para><command>systemd-tty-ask-password-agent</command> implements
docs: update old documentation links
2020-09-29 16:10:08 +03:00
the <ulink url="https://systemd.io/PASSWORD_AGENTS/">Password Agents
Specification</ulink>, and is one of many possible response agents which
man: add more links to systemd-ask-password and systemd-tty-ask-password-agent Loosely inspired by https://bugzilla.redhat.com/show_bug.cgi?id=1411134.
2017-01-09 21:51:06 +03:00
answer to queries formulated with
<citerefentry><refentrytitle>systemd-ask-password</refentrytitle><manvolnum>1</manvolnum></citerefentry>.
</para>
Reindent man pages to 2ch
2015-02-04 05:14:13 +03:00
</refsect1>
<refsect1>
<title>Options</title>
<para>The following options are understood:</para>
<variablelist>
<varlistentry>
<term><option>--list</option></term>
man: add version info This tries to add information about when each option was added. It goes back to version 183. The version info is included from a separate file to allow generating it, which would allow more control on the formatting of the final output.
2023-08-22 19:52:36 +03:00
<listitem><para>Lists all currently pending system password requests.</para>
<xi:include href="version-info.xml" xpointer="v186"/></listitem>
Reindent man pages to 2ch
2015-02-04 05:14:13 +03:00
</varlistentry>
<varlistentry>
<term><option>--query</option></term>
<listitem><para>Process all currently pending system password
requests by querying the user on the calling
man: add version info This tries to add information about when each option was added. It goes back to version 183. The version info is included from a separate file to allow generating it, which would allow more control on the formatting of the final output.
2023-08-22 19:52:36 +03:00
TTY.</para>
<xi:include href="version-info.xml" xpointer="v186"/></listitem>
Reindent man pages to 2ch
2015-02-04 05:14:13 +03:00
</varlistentry>
<varlistentry>
<term><option>--watch</option></term>
<listitem><para>Continuously process password
man: add version info This tries to add information about when each option was added. It goes back to version 183. The version info is included from a separate file to allow generating it, which would allow more control on the formatting of the final output.
2023-08-22 19:52:36 +03:00
requests.</para>
<xi:include href="version-info.xml" xpointer="v186"/></listitem>
Reindent man pages to 2ch
2015-02-04 05:14:13 +03:00
</varlistentry>
<varlistentry>
<term><option>--wall</option></term>
<listitem><para>Forward password requests to
<citerefentry project='man-pages'><refentrytitle>wall</refentrytitle><manvolnum>1</manvolnum></citerefentry>
instead of querying the user on the calling
man: add version info This tries to add information about when each option was added. It goes back to version 183. The version info is included from a separate file to allow generating it, which would allow more control on the formatting of the final output.
2023-08-22 19:52:36 +03:00
TTY.</para>
<xi:include href="version-info.xml" xpointer="v186"/></listitem>
Reindent man pages to 2ch
2015-02-04 05:14:13 +03:00
</varlistentry>
<varlistentry>
<term><option>--plymouth</option></term>
<listitem><para>Ask question with
<citerefentry project='die-net'><refentrytitle>plymouth</refentrytitle><manvolnum>8</manvolnum></citerefentry>
instead of querying the user on the calling
man: add version info This tries to add information about when each option was added. It goes back to version 183. The version info is included from a separate file to allow generating it, which would allow more control on the formatting of the final output.
2023-08-22 19:52:36 +03:00
TTY.</para>
<xi:include href="version-info.xml" xpointer="v186"/></listitem>
Reindent man pages to 2ch
2015-02-04 05:14:13 +03:00
</varlistentry>
<varlistentry>
tty-ask-password-agent: mention optional argument in help 0cf84693877f060254f04cf38120f52c2aa3059c added --console. 6af621248f2255f9ce50b0bafdde475305dc4e57 added an optional argument, but didn't update the help texts. Note that there is no ambiguity with the optional argument because no positional arguments are allowed.
2021-05-23 10:52:56 +03:00
<term><option>--console</option><optional>=<replaceable>DEVICE</replaceable></optional></term>
Reindent man pages to 2ch
2015-02-04 05:14:13 +03:00
tty-ask-password-agent: mention optional argument in help 0cf84693877f060254f04cf38120f52c2aa3059c added --console. 6af621248f2255f9ce50b0bafdde475305dc4e57 added an optional argument, but didn't update the help texts. Note that there is no ambiguity with the optional argument because no positional arguments are allowed.
2021-05-23 10:52:56 +03:00
<listitem><para>Ask question on TTY <replaceable>DEVICE</replaceable> instead of querying the user on
the calling TTY. If <replaceable>DEVICE</replaceable> is not specified,
man: add version info This tries to add information about when each option was added. It goes back to version 183. The version info is included from a separate file to allow generating it, which would allow more control on the formatting of the final output.
2023-08-22 19:52:36 +03:00
<filename>/dev/console</filename> will be used.</para>
man: update version information As I noticed a lot of missing information when trying to implement checking for missing info. I reimplemented the version information script to be more robust, and here is the result. Follow up to ec07c3c80b2b1bfa6788500202006ff85f5ae4f4
2023-09-18 18:03:38 +03:00
<xi:include href="version-info.xml" xpointer="v186"/></listitem>
Reindent man pages to 2ch
2015-02-04 05:14:13 +03:00
</varlistentry>
<xi:include href="standard-options.xml" xpointer="help" />
<xi:include href="standard-options.xml" xpointer="version" />
</variablelist>
</refsect1>
<refsect1>
<title>Exit status</title>
<para>On success, 0 is returned, a non-zero failure
code otherwise.</para>
</refsect1>
<refsect1>
<title>See Also</title>
<para>
<citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
<citerefentry><refentrytitle>systemctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
<citerefentry><refentrytitle>systemd-ask-password-console.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
<citerefentry project='man-pages'><refentrytitle>wall</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
<citerefentry project='die-net'><refentrytitle>plymouth</refentrytitle><manvolnum>8</manvolnum></citerefentry>
</para>
</refsect1>
man: document tty-ask-password-agent
2012-06-27 04:12:39 +04:00
</refentry>
Copy Permalink