iasync/doc/iasync.1.html
2025-01-22 20:27:19 -08:00

190 lines
7.5 KiB
HTML

<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8"/>
<meta name="viewport" content="width=device-width, initial-scale=1.0"/>
<style>
table.head, table.foot { width: 100%; }
td.head-rtitle, td.foot-os { text-align: right; }
td.head-vol { text-align: center; }
.Nd, .Bf, .Op { display: inline; }
.Pa, .Ad { font-style: italic; }
.Ms { font-weight: bold; }
.Bl-diag > dt { font-weight: bold; }
code.Nm, .Fl, .Cm, .Ic, code.In, .Fd, .Fn, .Cd { font-weight: bold;
font-family: inherit; }
</style>
<title>IASYNC(1)</title>
</head>
<body>
<table class="head">
<tr>
<td class="head-ltitle">IASYNC(1)</td>
<td class="head-vol">General Commands Manual</td>
<td class="head-rtitle">IASYNC(1)</td>
</tr>
</table>
<div class="manual-text">
<section class="Sh">
<h1 class="Sh" id="NAME"><a class="permalink" href="#NAME">NAME</a></h1>
<p class="Pp"><code class="Nm">iasync</code> &#x2014; <span class="Nd">sync
files to iOS app folders</span></p>
</section>
<section class="Sh">
<h1 class="Sh" id="SYNOPSIS"><a class="permalink" href="#SYNOPSIS">SYNOPSIS</a></h1>
<table class="Nm">
<tr>
<td><code class="Nm">iasync</code></td>
<td>[<var class="Ar">options</var>] <var class="Ar">command</var>
[<var class="Ar">command_options</var>]</td>
</tr>
</table>
<br/>
<table class="Nm">
<tr>
<td><code class="Nm">iasync</code></td>
<td><var class="Ar">lsdevs</var> [command_options]</td>
</tr>
</table>
<br/>
<table class="Nm">
<tr>
<td><code class="Nm">iasync</code></td>
<td><var class="Ar">lsapps</var> [command_options]</td>
</tr>
</table>
<br/>
<table class="Nm">
<tr>
<td><code class="Nm">iasync</code></td>
<td><var class="Ar">ls</var> [command_options]</td>
</tr>
</table>
<br/>
<table class="Nm">
<tr>
<td><code class="Nm">iasync</code></td>
<td><var class="Ar">sync</var> [command_options]
<var class="Ar">source</var> <var class="Ar">target</var></td>
</tr>
</table>
</section>
<section class="Sh">
<h1 class="Sh" id="DESCRIPTION"><a class="permalink" href="#DESCRIPTION">DESCRIPTION</a></h1>
<p class="Pp"><code class="Nm">iasync</code> syncs files to Documents folders
for iOS apps that support file sharing.</p>
<section class="Ss">
<h2 class="Ss" id="Global_Options"><a class="permalink" href="#Global_Options">Global
Options</a></h2>
<p class="Pp">The following options largely affect all commands, and should be
provided before the command name.</p>
<dl class="Bl-tag">
<dt id="n,"><a class="permalink" href="#n,"><code class="Fl">-n,</code></a>
<code class="Fl">--name</code> <var class="Ar">name</var></dt>
<dd style="width: auto;">&#x00A0;</dd>
<dt id="u,"><a class="permalink" href="#u,"><code class="Fl">-u,</code></a>
<code class="Fl">--udid</code> <var class="Ar">udid</var></dt>
<dd>Connect to the device with the provided name or UDID. This can be
discovered with the <var class="Ar">lsdevs</var> command if the device is
already connected.</dd>
<dt id="v,"><a class="permalink" href="#v,"><code class="Fl">-v,</code></a>
<code class="Fl">--verbose</code></dt>
<dd>Increases the verbosity. This can be used multiple times. This is mutally
exclusive with <code class="Fl">--quiet</code>.</dd>
<dt id="q,"><a class="permalink" href="#q,"><code class="Fl">-q,</code></a>
<code class="Fl">--quiet</code></dt>
<dd>Lowers the verbosity. This is mutually exclusive with
<code class="Fl">--verbose</code>.</dd>
</dl>
</section>
<section class="Ss">
<h2 class="Ss" id="Commands"><a class="permalink" href="#Commands">Commands</a></h2>
<dl class="Bl-tag">
<dt><code class="Nm">iasync</code> <code class="Ic">lsdevs</code>
[<code class="Fl">-n</code> | <code class="Fl">--no-headers</code>]</dt>
<dd>Lists devices connected to the computer as a table. For each connected
device, this shows the name, whether it's connected over USB or Network
(Wi-Fi), and its UDID.
<dl class="Bl-tag">
<dt id="n,~2"><a class="permalink" href="#n,~2"><code class="Fl">-n,</code></a>
<code class="Fl">--no-headers</code></dt>
<dd>Suppress the table headers.</dd>
</dl>
</dd>
<dt><code class="Nm">iasync</code> <code class="Ic">lsapps</code>
[<code class="Fl">-n</code> | <code class="Fl">--no-headers</code>]</dt>
<dd>Lists apps that support file sharing for the connected device.
<dl class="Bl-tag">
<dt id="n,~3"><a class="permalink" href="#n,~3"><code class="Fl">-n,</code></a>
<code class="Fl">--no-headers</code></dt>
<dd>Suppress the table headers.</dd>
</dl>
</dd>
<dt><code class="Nm">iasync</code> <code class="Ic">ls</code>
[<code class="Fl">-a</code> | <code class="Fl">--all</code>]
<var class="Ar">app_id</var>[<var class="Ar">:path</var>]</dt>
<dd>Lists all files in the directory provided by the
<var class="Ar">path</var> argument, relative to the root of the app's
Documents folder.
<dl class="Bl-tag">
<dt id="a,"><a class="permalink" href="#a,"><code class="Fl">-a,</code></a>
<code class="Fl">--all</code></dt>
<dd>Display entries with names starting with a dot (`.').</dd>
</dl>
</dd>
<dt><code class="Nm">iasync</code> <code class="Ic">sync</code>
[<code class="Fl">-Dnp</code>] <var class="Ar">source</var>
<var class="Ar">app_id</var>[<var class="Ar">:path</var>]</dt>
<dd>Copies the files from the <var class="Ar">source</var> directory to the
path provided by the <var class="Ar">app_id</var> and
<var class="Ar">path</var> arguments.
<dl class="Bl-tag">
<dt id="D,"><a class="permalink" href="#D,"><code class="Fl">-D,</code></a>
<code class="Fl">--allow-delete</code></dt>
<dd>Allow the sync operation to delete remote files to ensure the remote
directory tree matches the local tree.</dd>
<dt id="n,~4"><a class="permalink" href="#n,~4"><code class="Fl">-n,</code></a>
<code class="Fl">--dry-run</code></dt>
<dd>Explain what would have been done, instead of performing the
operations.</dd>
<dt id="p,"><a class="permalink" href="#p,"><code class="Fl">-p,</code></a>
<code class="Fl">--progress</code></dt>
<dd>Print progress information for files being copied.</dd>
</dl>
</dd>
</dl>
</section>
</section>
<section class="Sh">
<h1 class="Sh" id="EXIT_STATUS"><a class="permalink" href="#EXIT_STATUS">EXIT
STATUS</a></h1>
<p class="Pp"><code class="Nm">iasync</code> exits with either 1 or 2 if an
error occurred.</p>
</section>
<section class="Sh">
<h1 class="Sh" id="SEE_ALSO"><a class="permalink" href="#SEE_ALSO">SEE
ALSO</a></h1>
<p class="Pp"><a class="Xr">ifuse(1)</a>, <a class="Xr">idevicepair(1)</a></p>
</section>
<section class="Sh">
<h1 class="Sh" id="BUGS"><a class="permalink" href="#BUGS">BUGS</a></h1>
<p class="Pp"><code class="Nm">iasync</code> is still heavily in development,
and bugs are to be expected. While efforts are made to avoid loss of data,
users should ensure their files are backed up before performing a sync if
they have any important data that could be lost.</p>
<p class="Pp">Bugs can be reported on GitHub at:</p>
<p class="Pp"></p>
<div class="Bd
Bd-indent"><a class="Lk" href="https://github.com/snowkat/iasync">https://github.com/snowkat/iasync</a></div>
<p class="Pp">or by sending an e-mail to
<a class="Mt" href="mailto:snow@datagirl.xyz">snow@datagirl.xyz</a>.</p>
</section>
</div>
<table class="foot">
<tr>
<td class="foot-date">January 22, 2025</td>
<td class="foot-os">&nbsp;</td>
</tr>
</table>
</body>
</html>