shaba/ostree
1
0
Fork 0
mirror of https://github.com/ostreedev/ostree.git synced 2024-12-26 03:22:08 +03:00
Code Issues Projects Releases Wiki Activity
436ff11a00
ostree/man/ostree-commit.xml

346 lines
13 KiB
XML
Raw Normal View History

manpage: Add separate manpages for each command Using docker as a model, this update creates separate manpages for each OSTree command, such that the main manpage is not cluttered and the separate pages can provide more in-depth detail and exanples that might be useful to a user. Each page includes synopsis, description, example, and a list of options if needd. This update also alphabetizes the usage error output for ostree and ostree admin so that it matches the list on the manpage.
2014-06-17 23:24:08 +04:00
<?xml version='1.0'?> <!--*-nxml-*-->
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
<!--
Copyright 2014 Anne LoVerso <anne.loverso@students.olin.edu>
Add SPDX-License-Identifier to source files SPDX License List is a list of (common) open source licenses that can be referred to by a “short identifier”. It has several advantages compared to the common "license header texts" usually found in source files. Some of the advantages: * It is precise; there is no ambiguity due to variations in license header text * It is language neutral * It is easy to machine process * It is concise * It is simple and can be used without much cost in interpreted environments like java Script, etc. * An SPDX license identifier is immutable. * It provides simple guidance for developers who want to make sure the license for their code is respected See http://spdx.org for further reading. Signed-off-by: Marcus Folkesson <marcus.folkesson@gmail.com> Closes: #1439 Approved by: cgwalters
2018-01-30 22:26:26 +03:00
SPDX-License-Identifier: LGPL-2.0+
manpage: Add separate manpages for each command Using docker as a model, this update creates separate manpages for each OSTree command, such that the main manpage is not cluttered and the separate pages can provide more in-depth detail and exanples that might be useful to a user. Each page includes synopsis, description, example, and a list of options if needd. This update also alphabetizes the usage error output for ostree and ostree admin so that it matches the list on the manpage.
2014-06-17 23:24:08 +04:00
This library is free software; you can redistribute it and/or
modify it under the terms of the GNU Lesser General Public
License as published by the Free Software Foundation; either
version 2 of the License, or (at your option) any later version.
This library is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
Lesser General Public License for more details.
You should have received a copy of the GNU Lesser General Public
Update FSF license notices to use URL instead of address
2021-12-07 04:20:55 +03:00
License along with this library. If not, see <https://www.gnu.org/licenses/>.
manpage: Add separate manpages for each command Using docker as a model, this update creates separate manpages for each OSTree command, such that the main manpage is not cluttered and the separate pages can provide more in-depth detail and exanples that might be useful to a user. Each page includes synopsis, description, example, and a list of options if needd. This update also alphabetizes the usage error output for ostree and ostree admin so that it matches the list on the manpage.
2014-06-17 23:24:08 +04:00
-->
<refentry id="ostree">
<refentryinfo>
<title>ostree commit</title>
<productname>OSTree</productname>
<authorgroup>
<author>
<contrib>Developer</contrib>
<firstname>Colin</firstname>
<surname>Walters</surname>
<email>walters@verbum.org</email>
</author>
</authorgroup>
</refentryinfo>
<refmeta>
<refentrytitle>ostree commit</refentrytitle>
<manvolnum>1</manvolnum>
</refmeta>
<refnamediv>
<refname>ostree-commit</refname>
<refpurpose>Commit a new revision</refpurpose>
</refnamediv>
<refsynopsisdiv>
<cmdsynopsis>
docs: Fix a pile of Docbook validation errors At least now validates with RNG mode in Emacs.
2014-11-29 20:15:21 +03:00
<command>ostree commit</command> <arg choice="opt" rep="repeat">OPTIONS</arg> --branch=<arg choice="req">BRANCH</arg> <arg choice="opt">PATH</arg>
manpage: Add separate manpages for each command Using docker as a model, this update creates separate manpages for each OSTree command, such that the main manpage is not cluttered and the separate pages can provide more in-depth detail and exanples that might be useful to a user. Each page includes synopsis, description, example, and a list of options if needd. This update also alphabetizes the usage error output for ostree and ostree admin so that it matches the list on the manpage.
2014-06-17 23:24:08 +04:00
</cmdsynopsis>
</refsynopsisdiv>
<refsect1>
<title>Description</title>
<para>
commit: Update manpage to reflect --editor Closes: #305 Approved by: cgwalters
2016-05-23 22:32:36 +03:00
This allows you to commit changes to a branch. The specification of the branch is required. The command will print the checksum of a successful commit.
manpage: Add separate manpages for each command Using docker as a model, this update creates separate manpages for each OSTree command, such that the main manpage is not cluttered and the separate pages can provide more in-depth detail and exanples that might be useful to a user. Each page includes synopsis, description, example, and a list of options if needd. This update also alphabetizes the usage error output for ostree and ostree admin so that it matches the list on the manpage.
2014-06-17 23:24:08 +04:00
</para>
</refsect1>
<refsect1>
<title>Options</title>
<variablelist>
<varlistentry>
Various manpage / usage blurb improvements Corrections, clarifications, consistency. Not a comprehensive overhaul of the manpages; they do still need work. These are just flaws I've noted while studying the ostree command syntax. https://bugzilla.gnome.org/show_bug.cgi?id=740097
2014-11-11 05:28:43 +03:00
<term><option>--subject</option>, <option>-s</option>="SUBJECT"</term>
manpage: Add separate manpages for each command Using docker as a model, this update creates separate manpages for each OSTree command, such that the main manpage is not cluttered and the separate pages can provide more in-depth detail and exanples that might be useful to a user. Each page includes synopsis, description, example, and a list of options if needd. This update also alphabetizes the usage error output for ostree and ostree admin so that it matches the list on the manpage.
2014-06-17 23:24:08 +04:00
<listitem><para>
commit: Update manpage to reflect --editor Closes: #305 Approved by: cgwalters
2016-05-23 22:32:36 +03:00
One line subject. (optional)
manpage: Add separate manpages for each command Using docker as a model, this update creates separate manpages for each OSTree command, such that the main manpage is not cluttered and the separate pages can provide more in-depth detail and exanples that might be useful to a user. Each page includes synopsis, description, example, and a list of options if needd. This update also alphabetizes the usage error output for ostree and ostree admin so that it matches the list on the manpage.
2014-06-17 23:24:08 +04:00
</para></listitem>
</varlistentry>
<varlistentry>
Various manpage / usage blurb improvements Corrections, clarifications, consistency. Not a comprehensive overhaul of the manpages; they do still need work. These are just flaws I've noted while studying the ostree command syntax. https://bugzilla.gnome.org/show_bug.cgi?id=740097
2014-11-11 05:28:43 +03:00
<term><option>--body</option>, <option>-m</option>="BODY"</term>
manpage: Add separate manpages for each command Using docker as a model, this update creates separate manpages for each OSTree command, such that the main manpage is not cluttered and the separate pages can provide more in-depth detail and exanples that might be useful to a user. Each page includes synopsis, description, example, and a list of options if needd. This update also alphabetizes the usage error output for ostree and ostree admin so that it matches the list on the manpage.
2014-06-17 23:24:08 +04:00
<listitem><para>
commit: Update manpage to reflect --editor Closes: #305 Approved by: cgwalters
2016-05-23 22:32:36 +03:00
Full description. (optional)
</para></listitem>
</varlistentry>
man: add missing options to the ostree-commit man page Add missing parameter to the ostree-commit man page. Signed-off-by: Stefan Agner <stefan.agner@toradex.com>
2020-07-31 12:52:39 +03:00
<varlistentry>
<term><option>--body-file</option>, <option>-F</option>="FILE"</term>
<listitem><para>
Full commit description from a file. (optional)
</para></listitem>
</varlistentry>
commit: Update manpage to reflect --editor Closes: #305 Approved by: cgwalters
2016-05-23 22:32:36 +03:00
<varlistentry>
<term><option>--editor</option>, <option>-e</option></term>
<listitem><para>
Open a text editor for the commit description. It will use OSTREE_EDITOR, VISUAL, EDITOR, or vi, in descending order of preference. The commit will be aborted if the message is left empty.
manpage: Add separate manpages for each command Using docker as a model, this update creates separate manpages for each OSTree command, such that the main manpage is not cluttered and the separate pages can provide more in-depth detail and exanples that might be useful to a user. Each page includes synopsis, description, example, and a list of options if needd. This update also alphabetizes the usage error output for ostree and ostree admin so that it matches the list on the manpage.
2014-06-17 23:24:08 +04:00
</para></listitem>
</varlistentry>
<varlistentry>
Various manpage / usage blurb improvements Corrections, clarifications, consistency. Not a comprehensive overhaul of the manpages; they do still need work. These are just flaws I've noted while studying the ostree command syntax. https://bugzilla.gnome.org/show_bug.cgi?id=740097
2014-11-11 05:28:43 +03:00
<term><option>--branch</option>, <option>-b</option>="BRANCH"</term>
manpage: Add separate manpages for each command Using docker as a model, this update creates separate manpages for each OSTree command, such that the main manpage is not cluttered and the separate pages can provide more in-depth detail and exanples that might be useful to a user. Each page includes synopsis, description, example, and a list of options if needd. This update also alphabetizes the usage error output for ostree and ostree admin so that it matches the list on the manpage.
2014-06-17 23:24:08 +04:00
<listitem><para>
commit: Update manpage to reflect --editor Closes: #305 Approved by: cgwalters
2016-05-23 22:32:36 +03:00
Branch. Required, unless --orphan is given.
manpage: Add separate manpages for each command Using docker as a model, this update creates separate manpages for each OSTree command, such that the main manpage is not cluttered and the separate pages can provide more in-depth detail and exanples that might be useful to a user. Each page includes synopsis, description, example, and a list of options if needd. This update also alphabetizes the usage error output for ostree and ostree admin so that it matches the list on the manpage.
2014-06-17 23:24:08 +04:00
</para></listitem>
</varlistentry>
man: add missing options to the ostree-commit man page Add missing parameter to the ostree-commit man page. Signed-off-by: Stefan Agner <stefan.agner@toradex.com>
2020-07-31 12:52:39 +03:00
<varlistentry>
<term><option>--parent</option>="COMMIT"</term>
<listitem><para>
Parent checksum or "none" to explicitly use no parent. If not specified, <literal>BRANCH</literal> is used as parent (no parent in case <literal>BRANCH</literal> does not exist).
</para></listitem>
</varlistentry>
manpage: Add separate manpages for each command Using docker as a model, this update creates separate manpages for each OSTree command, such that the main manpage is not cluttered and the separate pages can provide more in-depth detail and exanples that might be useful to a user. Each page includes synopsis, description, example, and a list of options if needd. This update also alphabetizes the usage error output for ostree and ostree admin so that it matches the list on the manpage.
2014-06-17 23:24:08 +04:00
<varlistentry>
Various manpage / usage blurb improvements Corrections, clarifications, consistency. Not a comprehensive overhaul of the manpages; they do still need work. These are just flaws I've noted while studying the ostree command syntax. https://bugzilla.gnome.org/show_bug.cgi?id=740097
2014-11-11 05:28:43 +03:00
<term><option>--tree</option>="dir=PATH" or "tar=TARFILE" or "ref=COMMIT"</term>
manpage: Add separate manpages for each command Using docker as a model, this update creates separate manpages for each OSTree command, such that the main manpage is not cluttered and the separate pages can provide more in-depth detail and exanples that might be useful to a user. Each page includes synopsis, description, example, and a list of options if needd. This update also alphabetizes the usage error output for ostree and ostree admin so that it matches the list on the manpage.
2014-06-17 23:24:08 +04:00
<listitem><para>
man: Document ability to commit archives from stdin Closes: #1862 Approved by: jlebon
2019-05-21 16:28:19 +03:00
Overlay the given argument as a tree. When committing an archive, the TARFILE can be specified as <literal>-</literal> to read the archive from standard input.
manpage: Add separate manpages for each command Using docker as a model, this update creates separate manpages for each OSTree command, such that the main manpage is not cluttered and the separate pages can provide more in-depth detail and exanples that might be useful to a user. Each page includes synopsis, description, example, and a list of options if needd. This update also alphabetizes the usage error output for ostree and ostree admin so that it matches the list on the manpage.
2014-06-17 23:24:08 +04:00
</para></listitem>
</varlistentry>
commit: Add --base argument I was trying to followup the `--selinux-policy-from-base` work to add a `cosa build --fast=overlay` for coreos-assembler, but hit on the fact that using e.g. `--owner-uid` disables commit optimizations. A while ago, https://github.com/ostreedev/ostree/pull/1643 landed which optimized this for the case where no modifications are provided. But, we really need the SELinux policy bits, and it's super convenient to run `ostree commit` as non-root. It's fairly surprising actually that it's taken us so long to iterate on a good interface for this "commit changes on top of a base" model. In practice, many nontrivial cases really end up needing to do a (hardlink) checkout, and that case is optimized. But for this coreos-assembler work I want to directly overlay onto a commit object another commit object. That previous PR above added exactly the API we need, so let's expose it in the CLI. What you can see happening in the test is that we provide `--owner-uid 42`, but that only applies to directories/files that were added in the commit. And now that I look at this, I think what we really want here is to avoid changing directories that exist in the base, but eh; in practice the main use here is for `--owner-uid 0` while committing as non-root; and that works fine with this since the baseline uid will be zero as well.
2020-04-06 01:23:39 +03:00
<varlistentry>
<term><option>--base</option>="REV"</term>
<listitem><para>
Start from the content in a commit. This differs from <literal>--tree=ref=REV</literal> in that no commit modifiers are applied. This is usually what you want when
creating a derived commit. This is also used for <literal>--selinux-policy-from-base</literal>.
</para></listitem>
</varlistentry>
manpage: Add separate manpages for each command Using docker as a model, this update creates separate manpages for each OSTree command, such that the main manpage is not cluttered and the separate pages can provide more in-depth detail and exanples that might be useful to a user. Each page includes synopsis, description, example, and a list of options if needd. This update also alphabetizes the usage error output for ostree and ostree admin so that it matches the list on the manpage.
2014-06-17 23:24:08 +04:00
<varlistentry>
<term><option>--add-metadata-string</option>="KEY=VALUE"</term>
<listitem><para>
man: add missing options to the ostree-commit man page Add missing parameter to the ostree-commit man page. Signed-off-by: Stefan Agner <stefan.agner@toradex.com>
2020-07-31 12:52:39 +03:00
Add a key/value pair to metadata. Can be specified multiple times.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--add-metadata</option>="KEY=VALUE"</term>
<listitem><para>
Add a key/value pair to metadata, where the KEY is a string, and VALUE is g_variant_parse() formatted. Can be specified multiple times.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--keep-metadata</option>="KEY"</term>
<listitem><para>
Keep metadata KEY and its associated VALUE from parent. Can be specified multiple times.
manpage: Add separate manpages for each command Using docker as a model, this update creates separate manpages for each OSTree command, such that the main manpage is not cluttered and the separate pages can provide more in-depth detail and exanples that might be useful to a user. Each page includes synopsis, description, example, and a list of options if needd. This update also alphabetizes the usage error output for ostree and ostree admin so that it matches the list on the manpage.
2014-06-17 23:24:08 +04:00
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--add-detached-metadata-string</option>="KEY=VALUE"</term>
<listitem><para>
Various manpage / usage blurb improvements Corrections, clarifications, consistency. Not a comprehensive overhaul of the manpages; they do still need work. These are just flaws I've noted while studying the ostree command syntax. https://bugzilla.gnome.org/show_bug.cgi?id=740097
2014-11-11 05:28:43 +03:00
Add a key/value pair to detached metadata.
manpage: Add separate manpages for each command Using docker as a model, this update creates separate manpages for each OSTree command, such that the main manpage is not cluttered and the separate pages can provide more in-depth detail and exanples that might be useful to a user. Each page includes synopsis, description, example, and a list of options if needd. This update also alphabetizes the usage error output for ostree and ostree admin so that it matches the list on the manpage.
2014-06-17 23:24:08 +04:00
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--owner-uid</option>="UID"</term>
<listitem><para>
Set file ownership user id.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--owner-gid</option>="GID"</term>
<listitem><para>
Set file ownership group id.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--no-xattrs</option></term>
<listitem><para>
Do not import extended attributes.
</para></listitem>
</varlistentry>
Add an API+CLI to inject metadata for bootable OSTree commits I was doing some rpm-ostree work and I wanted to compare two OSTree commits to see if the kernel has changed. I think this should be a lot more natural. Add `ostree commit --bootable` which calls into a new generic library API `ostree_commit_metadata_for_bootable()` that discovers the kernel version and injects it as an `ostree.linux` metadata key. And for extra clarity, add an `ostree.bootable` key. It's interesting because the "core" OSTree layer is all about generic files, but this is adding special APIs around bootable OSTree commits (as opposed to e.g. flatpak as well as things like rpm-ostree's pkgcache refs). Eventually, I'd like to ensure everyone is using this and hard require this metadata key for the `ostree admin deploy` flow - mainly to prevent accidents.
2021-03-11 04:36:13 +03:00
<varlistentry>
<term><option>--bootable</option></term>
<listitem><para>
Inject standard metadata for a bootable Linux filesystem tree.
</para></listitem>
</varlistentry>
manpage: Add separate manpages for each command Using docker as a model, this update creates separate manpages for each OSTree command, such that the main manpage is not cluttered and the separate pages can provide more in-depth detail and exanples that might be useful to a user. Each page includes synopsis, description, example, and a list of options if needd. This update also alphabetizes the usage error output for ostree and ostree admin so that it matches the list on the manpage.
2014-06-17 23:24:08 +04:00
<varlistentry>
<term><option>--link-checkout-speedup</option></term>
<listitem><para>
Optimize for commits of trees composed of hardlinks into the repository.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--tar-autocreate-parents</option></term>
<listitem><para>
When loading tar archives, automatically create parent directories as needed.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--skip-if-unchanged</option></term>
<listitem><para>
If the contents are unchanged from previous commit, do nothing.
</para></listitem>
</varlistentry>
commit: Add _CONSUME modifier flag For many cases of commit, we can actually optimize things by simply "adopting" the object rather than writing a new copy. For example, in rpm-ostree package layering. We can only make that optimization though if we take ownership of the file. This commit hence adds an API where a caller tells us to do so. For now, that just means we `unlink()` the files/dirs as we go, but we can now later add the "adopt" optimization. Closes: #1255 Approved by: jlebon
2017-10-04 00:34:06 +03:00
<varlistentry>
<term><option>--consume</option></term>
<listitem><para>
When committing from a local directory (i.e. not an archive or --tree=ref),
assume ownership of the content. This may simply involve deleting it,
but if possible, the content may simply be <literal>rename()</literal>ed
into the repository rather than creating a new copy.
</para></listitem>
</varlistentry>
manpage: Add separate manpages for each command Using docker as a model, this update creates separate manpages for each OSTree command, such that the main manpage is not cluttered and the separate pages can provide more in-depth detail and exanples that might be useful to a user. Each page includes synopsis, description, example, and a list of options if needd. This update also alphabetizes the usage error output for ostree and ostree admin so that it matches the list on the manpage.
2014-06-17 23:24:08 +04:00
<varlistentry>
<term><option>--statoverride</option>="PATH"</term>
<listitem><para>
man: improve statoverride description A statoverride file written in the obvious way will produce incorrect results for two independent reasons. Document them.
2021-07-14 23:07:16 +03:00
File containing list of modifications to make permissions (file mode in
decimal, followed by space, followed by file path). The specified mode
is ORed with the file's original mode unless preceded by "=".
ot-builtin-commit.c: add --skip-list option This was already supported by the commit modifier API, just needed to expose it. This will also be used to test the libarchive API in a future test. Closes: #275 Approved by: cgwalters
2016-04-22 19:35:48 +03:00
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--skip-list</option>="PATH"</term>
<listitem><para>
File containing list of file paths to skip (one path per line).
manpage: Add separate manpages for each command Using docker as a model, this update creates separate manpages for each OSTree command, such that the main manpage is not cluttered and the separate pages can provide more in-depth detail and exanples that might be useful to a user. Each page includes synopsis, description, example, and a list of options if needd. This update also alphabetizes the usage error output for ostree and ostree admin so that it matches the list on the manpage.
2014-06-17 23:24:08 +04:00
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--table-output</option></term>
<listitem><para>
Output more information in a KEY: VALUE format.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--generate-sizes</option></term>
<listitem><para>
Generate size information along with commit metadata.
</para></listitem>
</varlistentry>
<varlistentry>
Various manpage / usage blurb improvements Corrections, clarifications, consistency. Not a comprehensive overhaul of the manpages; they do still need work. These are just flaws I've noted while studying the ostree command syntax. https://bugzilla.gnome.org/show_bug.cgi?id=740097
2014-11-11 05:28:43 +03:00
<term><option>--gpg-sign</option>="KEY-ID"</term>
manpage: Add separate manpages for each command Using docker as a model, this update creates separate manpages for each OSTree command, such that the main manpage is not cluttered and the separate pages can provide more in-depth detail and exanples that might be useful to a user. Each page includes synopsis, description, example, and a list of options if needd. This update also alphabetizes the usage error output for ostree and ostree admin so that it matches the list on the manpage.
2014-06-17 23:24:08 +04:00
<listitem><para>
GPG Key ID with which to sign the commit (if have GPGME - GNU Privacy Guard Made Easy).
</para></listitem>
</varlistentry>
<varlistentry>
Various manpage / usage blurb improvements Corrections, clarifications, consistency. Not a comprehensive overhaul of the manpages; they do still need work. These are just flaws I've noted while studying the ostree command syntax. https://bugzilla.gnome.org/show_bug.cgi?id=740097
2014-11-11 05:28:43 +03:00
<term><option>--gpg-homedir</option>="HOMEDIR"</term>
manpage: Add separate manpages for each command Using docker as a model, this update creates separate manpages for each OSTree command, such that the main manpage is not cluttered and the separate pages can provide more in-depth detail and exanples that might be useful to a user. Each page includes synopsis, description, example, and a list of options if needd. This update also alphabetizes the usage error output for ostree and ostree admin so that it matches the list on the manpage.
2014-06-17 23:24:08 +04:00
<listitem><para>
GPG home directory to use when looking for keyrings (if have GPGME - GNU Privacy Guard Made Easy).
</para></listitem>
</varlistentry>
commit: add --timestamp=TIMESTAMP It allows to override the timestamp of the commit. Signed-off-by: Giuseppe Scrivano <gscrivan@redhat.com>
2015-11-09 13:35:46 +03:00
<varlistentry>
<term><option>--timestamp</option>="TIMESTAMP"</term>
<listitem><para>
Override the timestamp of the commit to TIMESTAMP.
</para></listitem>
</varlistentry>
man: add missing options for commit Signed-off-by: Giuseppe Scrivano <gscrivan@redhat.com> Closes: #306 Approved by: cgwalters
2016-05-23 09:53:34 +03:00
<varlistentry>
<term><option>--orphan</option></term>
<listitem><para>
commit: Update manpage to reflect --editor Closes: #305 Approved by: cgwalters
2016-05-23 22:32:36 +03:00
Create a commit without writing to a ref (branch)
man: add missing options for commit Signed-off-by: Giuseppe Scrivano <gscrivan@redhat.com> Closes: #306 Approved by: cgwalters
2016-05-23 09:53:34 +03:00
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--fsync</option>="POLICY"</term>
<listitem><para>
POLICY is a boolean which specifies whether fsync should be used or not. Default to true.
</para></listitem>
</varlistentry>
man: document commit signing Added options descriptions for `ostree-commit` allowing to sign the commit. Signed-off-by: Denis Pynkin <denis.pynkin@collabora.com>
2019-11-10 19:17:58 +03:00
<varlistentry>
<term><option>-s, --sign-type</option></term>
<listitem><para>
Use particular signature engine. Currently
available <arg choice="plain">ed25519</arg> and <arg choice="plain">dummy</arg>
signature types.
The default is <arg choice="plain">ed25519</arg>.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--sign</option>="KEY-ID"</term>
<listitem><para>
There <literal>KEY-ID</literal> is:
<variablelist>
<varlistentry>
<term><option>for ed25519:</option></term>
<listitem><para>
<literal>base64</literal>-encoded secret key for commit signing.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>for dummy:</option></term>
<listitem><para>
ASCII-string used as secret key.
</para></listitem>
</varlistentry>
</variablelist>
</para></listitem>
</varlistentry>
manpage: Add separate manpages for each command Using docker as a model, this update creates separate manpages for each OSTree command, such that the main manpage is not cluttered and the separate pages can provide more in-depth detail and exanples that might be useful to a user. Each page includes synopsis, description, example, and a list of options if needd. This update also alphabetizes the usage error output for ostree and ostree admin so that it matches the list on the manpage.
2014-06-17 23:24:08 +04:00
</variablelist>
</refsect1>
<refsect1>
<title>Example</title>
<para><command>$ ostree commit --branch=my-branch --subject="Initial commit"</command></para>
docs: Fix a pile of Docbook validation errors At least now validates with RNG mode in Emacs.
2014-11-29 20:15:21 +03:00
<programlisting>
manpage: Add separate manpages for each command Using docker as a model, this update creates separate manpages for each OSTree command, such that the main manpage is not cluttered and the separate pages can provide more in-depth detail and exanples that might be useful to a user. Each page includes synopsis, description, example, and a list of options if needd. This update also alphabetizes the usage error output for ostree and ostree admin so that it matches the list on the manpage.
2014-06-17 23:24:08 +04:00
67e382b11d213a402a5313e61cbc69dfd5ab93cb07fbb8b71c2e84f79fa5d7dc
docs: Fix a pile of Docbook validation errors At least now validates with RNG mode in Emacs.
2014-11-29 20:15:21 +03:00
</programlisting>
manpage: Add separate manpages for each command Using docker as a model, this update creates separate manpages for each OSTree command, such that the main manpage is not cluttered and the separate pages can provide more in-depth detail and exanples that might be useful to a user. Each page includes synopsis, description, example, and a list of options if needd. This update also alphabetizes the usage error output for ostree and ostree admin so that it matches the list on the manpage.
2014-06-17 23:24:08 +04:00
</refsect1>
</refentry>
Reference in New Issue Copy Permalink