From ff45d9d71b85a618aed6d3d5e5056bada6ff81f9 Mon Sep 17 00:00:00 2001
From: Ryo Nakamura <upa@haeena.net>
Date: Tue, 6 Feb 2024 10:35:38 +0900
Subject: add two env vars to pass password/keyphrase (#9)

MSCP_SSH_AUTH_PASSWORD passes a password, and MSCP_SSH_AUTH_PASSPHRASE
passes a passphrase for publickey auth. They enable avoiding interactive
password input. Test cases are also added.
---
 doc/mscp.1.in | 18 ++++++++++++++++++
 doc/mscp.rst  | 15 ++++++++++++++-
 2 files changed, 32 insertions(+), 1 deletion(-)

(limited to 'doc')

diff --git a/doc/mscp.1.in b/doc/mscp.1.in
index 545ea09..b329c27 100644
--- a/doc/mscp.1.in
+++ b/doc/mscp.1.in
@@ -236,6 +236,24 @@ Prints help.
 .SH EXIT STATUS
 Exit status is 0 on success,  and >0 if an error occurs.
 
+.SH ENVIRONMENT
+
+.PP
+.B mscp
+recognizes the following environment variables.
+
+.TP
+.B MSCP_SSH_AUTH_PASSWORD
+This environment variable passes a password for password
+authentication to establish SSH connections.
+
+.TP
+.B MSCP_SSH_AUTH_PASSPHRASE
+This environment variable passes a passphrase for public-key
+authentication for establishing SSH connections.
+
+
+
 .SH NOTES
 
 .PP
diff --git a/doc/mscp.rst b/doc/mscp.rst
index ca4cf44..c4ed35b 100644
--- a/doc/mscp.rst
+++ b/doc/mscp.rst
@@ -2,7 +2,7 @@
 MSCP
 ====
 
-:Date:   v0.1.3
+:Date:   v0.1.3-15-g9908fb3
 
 NAME
 ====
@@ -147,6 +147,19 @@ EXIT STATUS
 
 Exit status is 0 on success, and >0 if an error occurs.
 
+ENVIRONMENT
+===========
+
+**mscp** recognizes the following environment variables.
+
+**MSCP_SSH_AUTH_PASSWORD**
+   This environment variable passes a password for password
+   authentication to establish SSH connections.
+
+**MSCP_SSH_AUTH_PASSPHRASE**
+   This environment variable passes a passphrase for public-key
+   authentication for establishing SSH connections.
+
 NOTES
 =====
 
-- 
cgit v1.2.3