Document new universal options

yadm.1

@@ -206,6 +206,50 @@ to "false".
 .B version
 Print the version of
 .BR yadm .
+.SH OPTIONS
+
+.B yadm
+supports a set of universal options that alter the paths it uses.
+The default paths are documented in the FILES section.
+Any path specified by these options must be fully qualified.
+If you always want to override one or more of these paths, it may be useful to create an alias for the
+.B yadm
+command.
+For example, the following alias could be used to override the repository directory.
+
+.RS
+alias yadm='yadm --yadm-repo /alternate/path/to/repo'
+.RE
+
+The following is the full list of universal options.
+Each option should be followed by a fully qualified path.
+.TP
+.B -Y,--yadm-dir
+Override the
+.B yadm
+directory.
+.B yadm
+stores its data relative to this directory.
+.TP
+.B --yadm-repo
+Override the location of the
+.B yadm
+repository.
+.TP
+.B --yadm-config
+Override the location of the
+.B yadm
+configuration file.
+.TP
+.B --yadm-encrypt
+Override the location of the
+.B yadm
+encryption configuration.
+.TP
+.B --yadm-archive
+Override the location of the
+.B yadm
+encrypted files archive.
 .SH CONFIGURATION
 .B yadm
 uses a configuration file named
@@ -386,19 +430,31 @@ The SSH directory processing can be disabled using the
 .I yadm.ssh-perms
 configuration.
 .SH FILES
+The following are the default paths
+.B yadm
+uses for its own data.
+These paths can be altered using universal options.
+See the OPTIONS section for details.
 .TP
-.I $HOME/.yadm/config
+.I $HOME/.yadm
+The
+.B yadm
+directory. By default, all data
+.B yadm
+stores is relative to this directory.
+.TP
+.I $YADM_DIR/config
 Configuration file for
 .BR yadm .
 .TP
-.I $HOME/.yadm/repo.git
+.I $YADM_DIR/repo.git
 Git repository used by
 .BR yadm .
 .TP
-.I $HOME/.yadm/encrypt
+.I $YADM_DIR/encrypt
 List of globs used for encrypt/decrypt
 .TP
-.I $HOME/.yadm/files.gpg
+.I $YADM_DIR/files.gpg
 All files encrypted with
 .B yadm encrypt
 are stored in this file.

yadm.md

@@ -120,6 +120,35 @@
        version
               Print the version of yadm.
 
+## OPTIONS
+       yadm supports a set of universal options that alter the paths it  uses.
+       The default paths are documented in the FILES section.  Any path speci-
+       fied by these options must be fully qualified.  If you always  want  to
+       override  one  or  more  of  these paths, it may be useful to create an
+       alias for the yadm command.  For example, the following alias could  be
+       used to override the repository directory.
+
+              alias yadm='yadm --yadm-repo /alternate/path/to/repo'
+
+       The  following  is  the  full  list  of universal options.  Each option
+       should be followed by a fully qualified path.
+
+       -Y,--yadm-dir
+              Override the yadm directory.  yadm stores its data  relative  to
+              this directory.
+
+       --yadm-repo
+              Override the location of the yadm repository.
+
+       --yadm-config
+              Override the location of the yadm configuration file.
+
+       --yadm-encrypt
+              Override the location of the yadm encryption configuration.
+
+       --yadm-archive
+              Override the location of the yadm encrypted files archive.
+
 ## CONFIGURATION
        yadm  uses  a  configuration  file named $HOME/.yadm/config.  This file
        uses the same format as git-config(1).  Also, you can control the  con-
@@ -255,16 +284,24 @@
        tory processing can be disabled using the yadm.ssh-perms configuration.
 
 ## FILES
-       $HOME/.yadm/config
+       The  following are the default paths yadm uses for its own data.  These
+       paths can be altered using universal options.  See the OPTIONS  section
+       for details.
+
+       $HOME/.yadm
+              The yadm directory. By default, all data yadm stores is relative
+              to this directory.
+
+       $YADM_DIR/config
               Configuration file for yadm.
 
-       $HOME/.yadm/repo.git
+       $YADM_DIR/repo.git
               Git repository used by yadm.
 
-       $HOME/.yadm/encrypt
+       $YADM_DIR/encrypt
               List of globs used for encrypt/decrypt
 
-       $HOME/.yadm/files.gpg
+       $YADM_DIR/files.gpg
               All files encrypted with yadm encrypt are stored in this file.
 
 ## EXAMPLES