From: AsamK Date: Sun, 15 Oct 2023 20:37:46 +0000 (+0200) Subject: Update documentation X-Git-Tag: v0.12.3~10 X-Git-Url: https://git.nmode.ca/signal-cli/commitdiff_plain/24069c8277cca7f8e94aa3f083980e85dca25269 Update documentation --- diff --git a/README.md b/README.md index b546a62c..a254e267 100644 --- a/README.md +++ b/README.md @@ -32,8 +32,8 @@ See [latest version](https://github.com/AsamK/signal-cli/releases). ```sh export VERSION= -wget https://github.com/AsamK/signal-cli/releases/download/v"${VERSION}"/signal-cli-"${VERSION}"-Linux.tar.gz -sudo tar xf signal-cli-"${VERSION}"-Linux.tar.gz -C /opt +wget https://github.com/AsamK/signal-cli/releases/download/v"${VERSION}"/signal-cli-"${VERSION}".tar.gz +sudo tar xf signal-cli-"${VERSION}".tar.gz -C /opt sudo ln -sf /opt/signal-cli-"${VERSION}"/bin/signal-cli /usr/local/bin/ ``` diff --git a/man/signal-cli.1.adoc b/man/signal-cli.1.adoc index b3431341..2b545fa2 100644 --- a/man/signal-cli.1.adoc +++ b/man/signal-cli.1.adoc @@ -96,6 +96,7 @@ If the account was deleted (with --delete-account) it cannot be reactivated. *-v*, *--voice*:: The verification should be done over voice, not SMS. +Voice verification only works if an SMS verification has been attempted before. *--captcha*:: The captcha token, required if registration failed with a captcha required error. @@ -146,6 +147,38 @@ Can fix problems with receiving messages. *-n* NAME, *--device-name* NAME:: Set a new device name for the primary or linked device +=== startChangeNumber + +Change an account to a new phone number with SMS or voice verification. +Use the finishChangeNumber command to complete the verification. + +NUMBER:: +The new phone number. + +*-v*, *--voice*:: +The verification should be done over voice, not SMS. +Voice verification only works if an SMS verification has been attempted before. + +*--captcha*:: +The captcha token, required if registration failed with a captcha required error. +To get the token, go to https://signalcaptchas.org/registration/generate.html +For the staging environment, use: https://signalcaptchas.org/staging/registration/generate.html +Check the developer tools for a redirect starting with signalcaptcha:// Everything after signalcaptcha:// is the captcha token. + +=== finishChangeNumber + +Verify the number using the code received via SMS or voice. + +NUMBER:: +The new phone number. + +*-v*, *--verification-code*:: +The verification code. + +*-p* PIN, *--pin* PIN:: +The registration lock PIN, that was set by the user. +Only required if a PIN was set. + === updateConfiguration Update signal configs and sync them to linked devices. @@ -272,6 +305,9 @@ Specify the mentions of the original message (same format as `--mention`). *--quote-text-style*:: Style parts of the original message text (same format as `--text-style`). +*--quote-attachment*:: +Specify the attachments of the original message (syntax: contentType[:filename[:previewFile]]), e.g. 'audio/aac' or 'image/png:test.png:/tmp/preview.jpg'. + *--preview-url*:: Specify the url for the link preview. The same url must also appear in the message body, otherwise the preview won't be displayed by the apps. diff --git a/src/main/java/org/asamk/signal/commands/SendCommand.java b/src/main/java/org/asamk/signal/commands/SendCommand.java index 1c3d91ba..51f1fa1e 100644 --- a/src/main/java/org/asamk/signal/commands/SendCommand.java +++ b/src/main/java/org/asamk/signal/commands/SendCommand.java @@ -80,7 +80,7 @@ public class SendCommand implements JsonRpcLocalCommand { .help("Quote with mention of another group member (syntax: start:length:recipientNumber)"); subparser.addArgument("--quote-attachment") .nargs("*") - .help("Specify the attachments of the original message (syntax: contentType[:filename[:previewFile]], e.g. 'audio/aac' or 'image/png:test.png:/tmp/preview.jpg'."); + .help("Specify the attachments of the original message (syntax: contentType[:filename[:previewFile]]), e.g. 'audio/aac' or 'image/png:test.png:/tmp/preview.jpg'."); subparser.addArgument("--quote-text-style") .nargs("*") .help("Quote with style parts of the message text (syntax: start:length:STYLE)");