summaryrefslogtreecommitdiffstats
path: root/docs/afcclient.1
diff options
context:
space:
mode:
Diffstat (limited to 'docs/afcclient.1')
-rw-r--r--docs/afcclient.174
1 files changed, 74 insertions, 0 deletions
diff --git a/docs/afcclient.1 b/docs/afcclient.1
new file mode 100644
index 0000000..a4eeacb
--- /dev/null
+++ b/docs/afcclient.1
@@ -0,0 +1,74 @@
1.TH "afcclient" 1
2.SH NAME
3afcclient \- Interact with AFC/HouseArrest service on a connected device.
4.SH SYNOPSIS
5.B afcclient
6[OPTIONS] [COMMAND ...]
7
8.SH DESCRIPTION
9
10Utility to interact with AFC/HouseArrest service. This allows access to parts
11of the filesystem on an iOS device.
12
13\f[B]afcclient\f[] can be used interactively with a command prompt, or run a single command and exit.
14
15.SH COMMANDS
16.TP
17.B devinfo
18print device information
19.TP
20.B info PATH
21print file attributes of file at PATH
22.TP
23.B ls PATH
24print directory contents of PATH
25.TP
26.B mv OLD NEW
27rename file OLD to NEW
28.TP
29.B mkdir PATH
30create directory at PATH
31.TP
32.B ln [-s] FILE [LINK]
33Create a (symbolic) link to file named LINKNAME. \f[B]NOTE: This feature has been disabled in newer versions of iOS\f[].
34.TP
35.B rm [-rf] PATH
36remove item at PATH
37.TP
38.B get [-rf] PATH [LOCALPATH]
39transfer file at PATH from device to LOCALPATH, or current directory if omitted. If LOCALPATH is a directory, the file will be stored inside the directory.
40.TP
41.B put [-rf] LOCALPATH [PATH]
42transfer local file at LOCALPATH to device at PATH, or current directory if omitted. If PATH is a directory, the file will be stored inside the directory.
43.TP
44
45.SH OPTIONS
46.TP
47.B \-u, \-\-udid UDID
48target specific device by UDID
49.TP
50.B \-n, \-\-network
51connect to network device (not recommended, since the connection might be terminated at any time)
52.TP
53.B \--container <appid>
54Access the app container directory of the app with given \f[B]appid\f[]
55.TP
56.B \--documents <appid>
57Access the Documents directory of the app with given \f[B]appid\f[]
58.TP
59.B \-h, \-\-help
60Prints usage information
61.TP
62.B \-d, \-\-debug
63Enable communication debugging
64.TP
65.B \-v, \-\-version
66Prints version information
67
68.SH AUTHOR
69Nikias Bassen
70
71.SH ON THE WEB
72https://libimobiledevice.org
73
74https://github.com/libimobiledevice/libimobiledevice