shaba/ostree
1
0
Fork 0
mirror of https://github.com/ostreedev/ostree.git synced 2025-01-06 17:18:25 +03:00
Code Issues Projects Releases Wiki Activity
6ce2324e4a
ostree/man/ostree-remote.xml

247 lines
9.0 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 remote</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 remote</refentrytitle>
<manvolnum>1</manvolnum>
</refmeta>
<refnamediv>
<refname>ostree-remote</refname>
<refpurpose>Control remote repository configuration</refpurpose>
</refnamediv>
<refsynopsisdiv>
<cmdsynopsis>
Add "ostree remote list" command Lists available remote names.
2014-12-16 18:41:34 +03:00
<command>ostree remote add</command> <arg choice="opt" rep="repeat">OPTIONS</arg> <arg choice="req">NAME</arg> <arg choice="req">URL</arg> <arg choice="opt" rep="repeat">BRANCH</arg>
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
</cmdsynopsis>
<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 remote delete</command> <arg choice="req">NAME</arg>
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
</cmdsynopsis>
<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 remote show-url</command> <arg choice="req">NAME</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>
Add "ostree remote list" command Lists available remote names.
2014-12-16 18:41:34 +03:00
<cmdsynopsis>
<command>ostree remote list</command> <arg choice="opt" rep="repeat">OPTIONS</arg> <arg choice="req">NAME</arg>
</cmdsynopsis>
ostree: Add a "remote gpg-import" command Imports GPG keys into a remote-specific keyring.
2015-05-01 16:09:42 +03:00
<cmdsynopsis>
<command>ostree remote gpg-import</command> <arg choice="opt" rep="repeat">OPTIONS</arg> <arg choice="req">NAME</arg> <arg choice="opt" rep="repeat">KEY-ID</arg>
</cmdsynopsis>
bin/remote: Add list-gpg-keys subcommand This provides a wrapper for the `ostree_repo_remote_get_gpg_keys` function to show the GPG keys associated with a remote. This is particularly useful for validating that GPG key updates have been applied. Tests are added, which checks the `ostree_repo_remote_get_gpg_keys` API by extension.
2019-08-13 19:10:50 +03:00
<cmdsynopsis>
bin/remote: Rename list-gpg-keys to gpg-list-keys As pointed out in the original review, `gpg-list-keys` fits better alongside the existing `gpg-import`. Changes were done with: ``` git grep -l list-gpg-keys | xargs sed -i 's/list-gpg-keys/gpg-list-keys/' for src in $(git ls-files '*list-gpg-keys*'); do dst=${src/list-gpg-keys/gpg-list-keys} git mv "$src" "$dst" done ```
2021-08-23 20:09:24 +03:00
<command>ostree remote gpg-list-keys</command> <arg choice="req">NAME</arg>
bin/remote: Add list-gpg-keys subcommand This provides a wrapper for the `ostree_repo_remote_get_gpg_keys` function to show the GPG keys associated with a remote. This is particularly useful for validating that GPG key updates have been applied. Tests are added, which checks the `ostree_repo_remote_get_gpg_keys` API by extension.
2019-08-13 19:10:50 +03:00
</cmdsynopsis>
ostree: Add a "remote refs" command Works like "ostree refs" but fetches refs from a remote repo. This depends on the remote repo having a summary file, but any repo being served over HTTP *ought* to have one.
2015-06-07 22:20:14 +03:00
<cmdsynopsis>
<command>ostree remote refs</command> <arg choice="req">NAME</arg>
</cmdsynopsis>
remote: Add "ostree remote summary" command Downloads and prints a remote summary file and any signatures in an easy-to-read format, or alternatively with the --raw option, prints the summary GVariant data directly. https://bugzilla.gnome.org/show_bug.cgi?id=759250
2015-12-17 02:55:28 +03:00
<cmdsynopsis>
<command>ostree remote summary</command> <arg choice="opt" rep="repeat">OPTIONS</arg> <arg choice="req">NAME</arg>
</cmdsynopsis>
Update documentation for cookie handling commands Closes: #531 Approved by: cgwalters
2016-10-17 23:47:58 +03:00
<cmdsynopsis>
<command>ostree remote add-cookie</command>
<arg choice="req">NAME</arg>
<arg choice="req">DOMAIN</arg>
<arg choice="req">PATH</arg>
<arg choice="req">COOKIE_NAME</arg>
<arg choice="req">VALUE</arg>
</cmdsynopsis>
<cmdsynopsis>
<command>ostree remote delete-cookie</command>
<arg choice="req">NAME</arg>
<arg choice="req">DOMAIN</arg>
<arg choice="req">PATH</arg>
<arg choice="req">COOKIE_NAME</arg>
<arg choice="req">VALUE</arg>
</cmdsynopsis>
<cmdsynopsis>
<command>ostree remote list-cookies</command> <arg choice="req">NAME</arg>
</cmdsynopsis>
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
</refsynopsisdiv>
<refsect1>
<title>Description</title>
<para>
Fix spelling of "repository" Detected by Debian's Lintian tool. Signed-off-by: Simon McVittie <smcv@debian.org> Closes: #519 Approved by: cgwalters
2016-10-01 18:07:08 +03:00
Changes remote repository configurations. The NAME refers to the name of the remote.
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>
man: document configured branches Closes: #1072 Closes: #1073 Approved by: guyshapiro
2017-08-10 16:05:15 +03:00
<para>
The <literal>BRANCH</literal> arguments to the
<command>add</command> subcommand specifies the configured branches
for the remote. See the <literal>branches</literal> section in
<citerefentry><refentrytitle>ostree.repo-config</refentrytitle><manvolnum>5</manvolnum></citerefentry>
for more information.
</para>
ostree: Add a "remote gpg-import" command Imports GPG keys into a remote-specific keyring.
2015-05-01 16:09:42 +03:00
<para>
bin/remote: Add list-gpg-keys subcommand This provides a wrapper for the `ostree_repo_remote_get_gpg_keys` function to show the GPG keys associated with a remote. This is particularly useful for validating that GPG key updates have been applied. Tests are added, which checks the `ostree_repo_remote_get_gpg_keys` API by extension.
2019-08-13 19:10:50 +03:00
The <command>gpg-import</command> subcommand can associate GPG
keys to a specific remote repository for use when pulling signed
commits from that repository (if GPG verification is enabled). The
bin/remote: Rename list-gpg-keys to gpg-list-keys As pointed out in the original review, `gpg-list-keys` fits better alongside the existing `gpg-import`. Changes were done with: ``` git grep -l list-gpg-keys | xargs sed -i 's/list-gpg-keys/gpg-list-keys/' for src in $(git ls-files '*list-gpg-keys*'); do dst=${src/list-gpg-keys/gpg-list-keys} git mv "$src" "$dst" done ```
2021-08-23 20:09:24 +03:00
<command>gpg-list-keys</command> subcommand can be used to see the
bin/remote: Add list-gpg-keys subcommand This provides a wrapper for the `ostree_repo_remote_get_gpg_keys` function to show the GPG keys associated with a remote. This is particularly useful for validating that GPG key updates have been applied. Tests are added, which checks the `ostree_repo_remote_get_gpg_keys` API by extension.
2019-08-13 19:10:50 +03:00
GPG keys currently associated with a remote repository.
ostree: Add a "remote gpg-import" command Imports GPG keys into a remote-specific keyring.
2015-05-01 16:09:42 +03:00
</para>
<para>
The GPG keys to import may be in binary OpenPGP format or ASCII armored. The optional <arg>KEY-ID</arg> list can restrict which keys are imported from a keyring file or input stream. All keys are imported if this list is omitted. If neither <option>--keyring</option> nor <option>--stdin</option> options are given, then keys are imported from the user's personal GPG keyring.
</para>
Update documentation for cookie handling commands Closes: #531 Approved by: cgwalters
2016-10-17 23:47:58 +03:00
<para>
The various cookie related command allow management of a remote specific cookie jar.
</para>
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>
<refsect1>
Add "ostree remote list" command Lists available remote names.
2014-12-16 18:41:34 +03:00
<title>'Add' Options</title>
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>
<varlistentry>
<term><option>--set</option>="KEY=VALUE"</term>
<listitem><para>
Set config option KEY=VALUE for remote.
</para></listitem>
</varlistentry>
man: Document remote add --if-not-exists option Closes: #1166 Approved by: cgwalters
2017-09-12 23:20:46 +03:00
<varlistentry>
<term><option>--if-not-exists</option></term>
<listitem><para>
Do nothing if the provided remote exists.
</para></listitem>
</varlistentry>
remote-add: Add --force option to add or replace remote This uses the OSTREE_REPO_REMOTE_CHANGE_REPLACE operation to add a remote or replace an existing one. This is roughly the opposite of --if-not-exists and will raise an error if both options are passed. Closes: #1166 Approved by: cgwalters
2017-09-13 01:05:08 +03:00
<varlistentry>
<term><option>--force</option></term>
<listitem><para>
Replace the provided remote if it exists.
</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>--no-gpg-verify</option></term>
<listitem><para>
Disable GPG verification.
</para></listitem>
</varlistentry>
ostree: Add --gpg-import to the "remote add" command Convenience option imports GPG keys for a newly-created remote.
2015-05-09 16:50:24 +03:00
<varlistentry>
<term><option>--gpg-import</option>=FILE</term>
<listitem><para>
Import one or more GPG keys from a file.
</para><para>
Equivalent to
<command>ostree remote gpg-import --keyring=FILE</command>.
</para></listitem>
</varlistentry>
remote-add: Add a --collection-id argument to the built-in add command This allows newly configured remotes to have their collection ID specified, so that refs from them can be downloaded from peers as well as the upstream collection, using the remote’s configuration. Signed-off-by: Philip Withnall <withnall@endlessm.com> Closes: #924 Approved by: cgwalters
2017-06-07 16:50:51 +03:00
<varlistentry>
<term><option>--collection-id</option>=COLLECTION-ID</term>
<listitem><para>
Set the collection ID for the remote to a value provided by
the repository owner, which allows refs from this remote to be
shared peer to peer.
</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>
Add "ostree remote list" command Lists available remote names.
2014-12-16 18:41:34 +03:00
<refsect1>
<title>'List' Options</title>
<variablelist>
<varlistentry>
<term><option>-u, --show-urls</option></term>
<listitem><para>
Show remote URLs in list
</para></listitem>
</varlistentry>
</variablelist>
</refsect1>
ostree: Add a "remote gpg-import" command Imports GPG keys into a remote-specific keyring.
2015-05-01 16:09:42 +03:00
<refsect1>
<title>'GPG-Import' Options</title>
<variablelist>
<varlistentry>
<term><option>-k, --keyring</option>=FILE</term>
<listitem><para>
Import one or more keys from a file.
</para><para>
This option may be repeated to import from multiple files,
but may not be used in combination with
<option>--stdin</option>.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--stdin</option></term>
<listitem><para>
Import one or more keys from standard input.
</para><para>
This option may not be used in combination with
<option>--keyring</option>.
</para></listitem>
</varlistentry>
</variablelist>
</refsect1>
remote: Add "ostree remote summary" command Downloads and prints a remote summary file and any signatures in an easy-to-read format, or alternatively with the --raw option, prints the summary GVariant data directly. https://bugzilla.gnome.org/show_bug.cgi?id=759250
2015-12-17 02:55:28 +03:00
<refsect1>
<title>'Summary' Options</title>
<variablelist>
<varlistentry>
<term><option>--raw</option></term>
<listitem><para>
Show raw variant data
</para></listitem>
</varlistentry>
</variablelist>
</refsect1>
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>
<title>Example</title>
<para><command>$ ostree remote show-url local</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
http://192.168.122.1/repo
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