mirror/flatpak
1
0
Fork 0
mirror of https://github.com/flatpak/flatpak.git synced 2026-03-12 12:08:08 -04:00
Code Issues Packages Projects Releases Wiki Activity

doc: Add a man page for the repair command

Browse Source 
Add a man page based on one of the comments in
app/flatpak-builtins-repair.c

Fixes https://github.com/flatpak/flatpak/issues/1820
This commit is contained in:
Matthew Leeds
2018-07-16 17:39:06 -07:00
parent ea36e8e83f
commit af10bb98ec
3 changed files with 150 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

1
doc/Makefile.am
View File

@@ -55,6 +55,7 @@ man1 = \
flatpak-repo.1 \
flatpak-search.1 \
flatpak-create-usb.1 \
flatpak-repair.1 \
$(NULL)
man5 = \

1
doc/flatpak-docs.xml.in
View File

@@ -55,6 +55,7 @@
<xi:include href="@srcdir@/flatpak-remote-ls.xml"/>
<xi:include href="@srcdir@/flatpak-remote-modify.xml"/>
<xi:include href="@srcdir@/flatpak-remotes.xml"/>
<xi:include href="@srcdir@/flatpak-repair.xml"/>
<xi:include href="@srcdir@/flatpak-repo.xml"/>
<xi:include href="@srcdir@/flatpak-run.xml"/>
<xi:include href="@srcdir@/flatpak-search.xml"/>

148
doc/flatpak-repair.xml Normal file
View File

@@ -0,0 +1,148 @@
<?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">
<refentry id="flatpak-repair">
<refentryinfo>
<title>flatpak repair</title>
<productname>flatpak</productname>
<authorgroup>
<author>
<contrib>Developer</contrib>
<firstname>Matthew</firstname>
<surname>Leeds</surname>
<email>matthew.leeds@endlessm.com</email>
</author>
</authorgroup>
</refentryinfo>
<refmeta>
<refentrytitle>flatpak repair</refentrytitle>
<manvolnum>1</manvolnum>
</refmeta>
<refnamediv>
<refname>flatpak-repair</refname>
<refpurpose>Repair a flatpak installation</refpurpose>
</refnamediv>
<refsynopsisdiv>
<cmdsynopsis>
<command>flatpak repair</command>
<arg choice="opt" rep="repeat">OPTION</arg>
</cmdsynopsis>
</refsynopsisdiv>
<refsect1>
<title>Description</title>
<para>
Repair a flatpak installation by pruning and reinstalling invalid objects. The repair command does all of the following:
</para>
<itemizedlist>
<listitem><para>
Scan all locally available refs, removing any that don't correspond to a deployed ref.
</para></listitem>
<listitem><para>
Verify each commit they point to, removing any invalid objects and noting any missing objects.
</para></listitem>
<listitem><para>
Remove any refs that had an invalid object, and any non-partial refs that had missing objects.
</para></listitem>
<listitem><para>
Prune all objects not referenced by a ref, which gets rid of any possibly invalid non-scanned objects.
</para></listitem>
<listitem><para>
Enumerate all deployed refs and re-install any that are not in the repo (or are partial for a non-subdir deploy).
</para></listitem>
</itemizedlist>
</refsect1>
<refsect1>
<title>Options</title>
<para>The following options are understood:</para>
<variablelist>
<varlistentry>
<term><option>-h</option></term>
<term><option>--help</option></term>
<listitem><para>
Show help options and exit.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--user</option></term>
<listitem><para>
Configure per-user installation.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--system</option></term>
<listitem><para>
Configure system-wide installation.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--installation=NAME</option></term>
<listitem><para>
Configure the system-wide installation
specified by <arg choice="plain">NAME</arg> among those defined in
<filename>/etc/flatpak/installations.d/</filename>. Using
<arg choice="plain">--installation=default</arg> is equivalent to using
<arg choice="plain">--system</arg>.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>-v</option></term>
<term><option>--verbose</option></term>
<listitem><para>
Print debug information during command processing.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--ostree-verbose</option></term>
<listitem><para>
Print OSTree debug information during command processing.
</para></listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1>
<title>Examples</title>
<para>
<command>$ sudo flatpak repair</command>
</para>
<para>
<command>$ flatpak repair --user</command>
</para>
</refsect1>
<refsect1>
<title>See also</title>
<para>
<citerefentry><refentrytitle>flatpak</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
</para>
</refsect1>
</refentry>