Update androdeb command naming to adeb
Signed-off-by: Joel Fernandes <joel@joelfernandes.org>
diff --git a/BCC.md b/BCC.md
index fc8080c..9042361 100644
--- a/BCC.md
+++ b/BCC.md
@@ -24,7 +24,7 @@
run the following command pointing androdeb to the kernel sources which will
have it extract headers from there and push them to the device.
```
-androdeb prepare --download --bcc --kernelsrc /path/to/kernel-source/
+adeb prepare --download --bcc --kernelsrc /path/to/kernel-source/
```
This downloads and installs a pre-built androdeb filesystem containing a recent
version of BCC onto the android device, extracts kernel headers from the source
@@ -33,7 +33,7 @@
[Other Architectures
section](https://github.com/joelagnel/androdeb/blob/master/BCC.md#other-architectures-other-than-arm64)
-Now to run BCC, just start an androdeb shell: `androdeb shell`. This uses adb
+Now to run BCC, just start an adeb shell: `adeb shell`. This uses adb
as the backend to start a shell into your androdeb environment. Try running
`opensnoop` or any of the other BCC tracers to confirm that the setup worked
correctly.
@@ -61,11 +61,11 @@
Build BCC during androdeb install (Optional)
--------------------------------------------
If you would like the latest BCC installation on your Android device, we
-recommend dropping the `--download` option from the androdeb command above.
-This will make androdeb clone and build the latest version for of BCC for the
+recommend dropping the `--download` option from the adeb command above.
+This will make androdeb clone and build the latest version of BCC for the
target architecture. Note that this is much slower that `--download`.
```
-androdeb prepare --bcc --kernelsrc /path/to/kernel-source/
+adeb prepare --bcc --kernelsrc /path/to/kernel-source/
```
Other Architectures (other than ARM64)
@@ -74,7 +74,7 @@
processor architecture. For other architectures, use the --arch option. For
example for x86_64 architecture, run:
```
-androdeb prepare --arch amd64 --bcc --kernelsrc /path/to/kernel-source/
+adeb prepare --arch amd64 --bcc --kernelsrc /path/to/kernel-source/
```
Note: The --download option ignores the --arch flag. This is because we only
provide pre-built filesystems for ARM64 at the moment.
diff --git a/README.md b/README.md
index aa90051..09a5223 100644
--- a/README.md
+++ b/README.md
@@ -1,10 +1,11 @@
androdeb
--------
-**androdeb** provides a powerful Linux shell environment where one can
-run popular and mainstream Linux tracing, compiling, editing and other
-development tools on an existing Android device. All the commands typically
-available on a modern Linux system are supported in androdeb.
+**androdeb** (also known as **adeb**) provides a powerful Linux shell
+environment where one can run popular and mainstream Linux tracing, compiling,
+editing and other development tools on an existing Android device. All the
+commands typically available on a modern Linux system are supported in
+androdeb.
Usecases
--------
@@ -47,50 +48,53 @@
```
git clone https://github.com/joelagnel/androdeb.git
cd androdeb
+
+# Add some short cuts:
+sudo ln -s ./adeb /usr/bin/adeb
sudo ln -s ./androdeb /usr/bin/androdeb
```
-* Fastest way of installing androdeb onto your device:
+* Fastest way of installing adeb onto your device:
```
# First make sure device is connected to system
-androdeb prepare --download
+adeb prepare --download
```
-* Now run androdeb shell to enter your new environment!:
+* Now run adeb shell to enter your new environment!:
```
-androdeb shell
+adeb shell
```
* Once done, hit `CTRL + D` and you will exit out of the shell.
To remove androdeb from the device, run:
```
-androdeb remove
+adeb remove
```
If you have multiple devices connected, please add `-s <serialnumber>`.
Serial numbers of all devices connected can be obtained by `adb devices`.
* To update the androdeb you cloned on your host, run:
```
-androdeb pull
+adeb pull
```
To update an existing androdeb clone on your host, run:
```
-androdeb git-pull
+adeb git-pull
```
More advanced usage instructions
--------------------------------
### Install kernel headers in addition to preparing androdeb device:
```
-androdeb prepare --download --kernelsrc /path/to/kernel-source
+adeb prepare --download --kernelsrc /path/to/kernel-source
```
### Update kernel headers onto an already prepared device:
If you need to put kernel sources for an existing install, run:
```
-androdeb prepare --kernelsrc /path/to/kernel-source --skip-install
+adeb prepare --kernelsrc /path/to/kernel-source --skip-install
```
Note: The kernel sources should have been built (atleast build should have started).
@@ -98,23 +102,23 @@
The androdeb fs will be prepared locally by downloading packages as needed:
```
-androdeb prepare --fullbuild
+adeb prepare --fullbuild
```
This is unlike `--download` where the androdeb rootfs is itself pulled from the web.
### Add kernel headers to device in addition to building locally:
```
-androdeb prepare --fullbuild --kernelsrc /path/to/kernel-source/
+adeb prepare --fullbuild --kernelsrc /path/to/kernel-source/
```
### Instead of `--fullbuild`, customize what you install:
```
-androdeb prepare --editors --compilers
+adeb prepare --editors --compilers
```
### Install only BCC:
```
-androdeb prepare --bcc --kernelsrc /path/to/kernel-source/
+adeb prepare --bcc --kernelsrc /path/to/kernel-source/
```
Note: BCC is built while being installed. Also `--kernelsrc` is
recommended for tools to function unless device has them
@@ -122,7 +126,7 @@
### Extract the FS from the device, after its prepared:
```
-androdeb prepare --fullbuild --buildtar /path/
+adeb prepare --fullbuild --buildtar /path/
```
After device is prepared, it will extract the root fs from it
and store it as a tar archive at `/path/androdeb-fs.tgz`. This
@@ -130,12 +134,12 @@
### Use a previously prepared androdeb rootfs tar from local:
```
-androdeb prepare --archive /path/androdeb-fs.tgz
+adeb prepare --archive /path/androdeb-fs.tgz
```
### Build a standalone raw EXT4 image out of the FS:
```
-androdeb prepare --buildimage /path/to/image.img
+adeb prepare --buildimage /path/to/image.img
```
This can then be passed to Qemu as -hda. Note: This option doesn't need a
device connected.
@@ -145,7 +149,7 @@
processor architecture. For other architectures, use the --arch option. For
example for x86_64 architecture, run:
```
-androdeb prepare --arch amd64 --bcc --kernelsrc /path/to/kernel-source/
+adeb prepare --arch amd64 --bcc --kernelsrc /path/to/kernel-source/
```
Note: The --download option ignores the --arch flag. This is because we only
provide pre-built filesystems for ARM64 at the moment.
diff --git a/adeb b/adeb
new file mode 100755
index 0000000..a651772
--- /dev/null
+++ b/adeb
@@ -0,0 +1,6 @@
+#!/bin/bash -e
+#
+# (c) Joel Fernandes <joel@joelfernandes.org>
+
+spath="$(dirname "$(readlink -f "$0")")"
+source $spath/androdeb
diff --git a/androdeb b/androdeb
index d538e16..5d9a2ce 100755
--- a/androdeb
+++ b/androdeb
@@ -68,7 +68,7 @@
esac
done
-[ -z $ASHELL ] && box_out "androdeb: $VERSION"
+[ -z $ASHELL ] && box_out "adeb: $VERSION"
if [ ! -z $BTAR ] && [ -z $TARDIR ]; then
TARDIR=$spath
diff --git a/utils/banners b/utils/banners
index f873fdb..491d324 100755
--- a/utils/banners
+++ b/utils/banners
@@ -7,7 +7,7 @@
usage() {
c_info "USAGE:"
- c_info "androdeb"
+ c_info "adeb"
c_info " shell Enter the androdeb shell environment and get to work!"
c_info " remove Remove androdeb from the device"
c_info " git-pull Git pull androdeb to update it on your host"
