mirror of
https://github.com/ostreedev/ostree.git
synced 2024-10-27 18:55:11 +03:00
b33a4e9b1e
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
242 lines
8.7 KiB
XML
242 lines
8.7 KiB
XML
<?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>
|
|
|
|
SPDX-License-Identifier: LGPL-2.0+
|
|
|
|
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
|
|
License along with this library; if not, write to the
|
|
Free Software Foundation, Inc., 59 Temple Place - Suite 330,
|
|
Boston, MA 02111-1307, USA.
|
|
-->
|
|
|
|
<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>
|
|
<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>
|
|
</cmdsynopsis>
|
|
<cmdsynopsis>
|
|
<command>ostree remote delete</command> <arg choice="req">NAME</arg>
|
|
</cmdsynopsis>
|
|
<cmdsynopsis>
|
|
<command>ostree remote show-url</command> <arg choice="req">NAME</arg>
|
|
</cmdsynopsis>
|
|
<cmdsynopsis>
|
|
<command>ostree remote list</command> <arg choice="opt" rep="repeat">OPTIONS</arg> <arg choice="req">NAME</arg>
|
|
</cmdsynopsis>
|
|
<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>
|
|
<cmdsynopsis>
|
|
<command>ostree remote refs</command> <arg choice="req">NAME</arg>
|
|
</cmdsynopsis>
|
|
<cmdsynopsis>
|
|
<command>ostree remote summary</command> <arg choice="opt" rep="repeat">OPTIONS</arg> <arg choice="req">NAME</arg>
|
|
</cmdsynopsis>
|
|
<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>
|
|
</refsynopsisdiv>
|
|
|
|
<refsect1>
|
|
<title>Description</title>
|
|
|
|
<para>
|
|
Changes remote repository configurations. The NAME refers to the name of the remote.
|
|
</para>
|
|
<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>
|
|
<para>
|
|
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).
|
|
</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>
|
|
<para>
|
|
The various cookie related command allow management of a remote specific cookie jar.
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1>
|
|
<title>'Add' Options</title>
|
|
|
|
<variablelist>
|
|
<varlistentry>
|
|
<term><option>--set</option>="KEY=VALUE"</term>
|
|
|
|
<listitem><para>
|
|
Set config option KEY=VALUE for remote.
|
|
</para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term><option>--if-not-exists</option></term>
|
|
|
|
<listitem><para>
|
|
Do nothing if the provided remote exists.
|
|
</para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term><option>--force</option></term>
|
|
|
|
<listitem><para>
|
|
Replace the provided remote if it exists.
|
|
</para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term><option>--no-gpg-verify</option></term>
|
|
|
|
<listitem><para>
|
|
Disable GPG verification.
|
|
</para></listitem>
|
|
</varlistentry>
|
|
|
|
<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>
|
|
|
|
<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>
|
|
</variablelist>
|
|
</refsect1>
|
|
|
|
<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>
|
|
|
|
<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>
|
|
|
|
<refsect1>
|
|
<title>'Summary' Options</title>
|
|
|
|
<variablelist>
|
|
<varlistentry>
|
|
<term><option>--raw</option></term>
|
|
|
|
<listitem><para>
|
|
Show raw variant data
|
|
</para></listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</refsect1>
|
|
|
|
<refsect1>
|
|
<title>Example</title>
|
|
<para><command>$ ostree remote show-url local</command></para>
|
|
<programlisting>
|
|
http://192.168.122.1/repo
|
|
</programlisting>
|
|
</refsect1>
|
|
</refentry>
|