diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/afcclient.1 | 76 |
1 files changed, 76 insertions, 0 deletions
diff --git a/docs/afcclient.1 b/docs/afcclient.1 new file mode 100644 index 0000000..ca7cb86 --- /dev/null +++ b/docs/afcclient.1 | |||
| @@ -0,0 +1,76 @@ | |||
| 1 | .TH "afcclient" 1 | ||
| 2 | .SH NAME | ||
| 3 | afcclient \- Interact with AFC/HouseArrest service on a connected device. | ||
| 4 | .SH SYNOPSIS | ||
| 5 | .B afcclient | ||
| 6 | [OPTIONS] [COMMAND ...] | ||
| 7 | |||
| 8 | .SH DESCRIPTION | ||
| 9 | |||
| 10 | Utility to interact with AFC/HouseArrest service. This allows access to parts | ||
| 11 | of 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 | ||
| 18 | print device information | ||
| 19 | .TP | ||
| 20 | .B info PATH | ||
| 21 | print file attributes of file at PATH | ||
| 22 | .TP | ||
| 23 | .B ls PATH | ||
| 24 | print directory contents of PATH | ||
| 25 | .TP | ||
| 26 | .B mv OLD NEW | ||
| 27 | rename file OLD to NEW | ||
| 28 | .TP | ||
| 29 | .B mkdir PATH | ||
| 30 | create directory at PATH | ||
| 31 | .TP | ||
| 32 | .B ln [-s] FILE [LINK] | ||
| 33 | Create 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 PATH | ||
| 36 | remove item at PATH | ||
| 37 | .TP | ||
| 38 | .B get PATH [LOCALPATH] | ||
| 39 | transfer 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 | \f[B]WARNING\f[]: Existing files will be overwritten! | ||
| 41 | .TP | ||
| 42 | .B put LOCALPATH [PATH] | ||
| 43 | transfer 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. | ||
| 44 | \f[B]WARNING\f[]: Existing files will be overwritten! | ||
| 45 | .TP | ||
| 46 | |||
| 47 | .SH OPTIONS | ||
| 48 | .TP | ||
| 49 | .B \-u, \-\-udid UDID | ||
| 50 | target specific device by UDID | ||
| 51 | .TP | ||
| 52 | .B \-n, \-\-network | ||
| 53 | connect to network device (not recommended, since the connection might be terminated at any time) | ||
| 54 | .TP | ||
| 55 | .B \--container <appid> | ||
| 56 | Access the app container directory of the app with given \f[B]appid\f[] | ||
| 57 | .TP | ||
| 58 | .B \--documents <appid> | ||
| 59 | Access the Documents directory of the app with given \f[B]appid\f[] | ||
| 60 | .TP | ||
| 61 | .B \-h, \-\-help | ||
| 62 | Prints usage information | ||
| 63 | .TP | ||
| 64 | .B \-d, \-\-debug | ||
| 65 | Enable communication debugging | ||
| 66 | .TP | ||
| 67 | .B \-v, \-\-version | ||
| 68 | Prints version information | ||
| 69 | |||
| 70 | .SH AUTHOR | ||
| 71 | Nikias Bassen | ||
| 72 | |||
| 73 | .SH ON THE WEB | ||
| 74 | https://libimobiledevice.org | ||
| 75 | |||
| 76 | https://github.com/libimobiledevice/libimobiledevice | ||