From 5f43b30a6f469b5feab2ffeb3147f7310f1ba47f Mon Sep 17 00:00:00 2001 From: Pino Toscano Date: Wed, 30 Aug 2017 16:16:16 +0200 Subject: [PATCH] fish: add small documentation bit about format of URIs (RHBZ#1450325) Mention which format URIs follow, with a small example on escaping special characters. --- fish/guestfish.pod | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/fish/guestfish.pod b/fish/guestfish.pod index c3f684563..1201176e9 100644 --- a/fish/guestfish.pod +++ b/fish/guestfish.pod @@ -1225,6 +1225,16 @@ The equivalent API command would be: > add /disk protocol:ssh server:tcp:example.com [username:user] +Note that the URIs follow the syntax of +L: in particular, there +are restrictions on the allowed characters for the various components +of the URI. Characters such as C<:>, C<@>, and C B be +percent-encoded: + + $ guestfish -a ssh://user:pass%40word@example.com/disk.img + +In this case, the password is C. + =head1 PROGRESS BARS Some (not all) long-running commands send progress notification