It will be easier to look up the documentation on GitHub.
all: adduser-novaboot.8 novaboot-shell.1
-adduser-novaboot.8: adduser-novaboot
+adduser-novaboot.8: adduser-novaboot.pod
pod2man --section=8 --center="System Manager's Manual" $< $@
-novaboot-shell.1: novaboot-shell
+novaboot-shell.1: novaboot-shell.pod
pod2man --center="User commands" $< $@
install: all
EOF
fi
-
-
echo "Done"
-exit 0
-
-: <<EOF
-=encoding utf8
-
-=head1 NAME
-
-adduser-novaboot - create user account for use with novaboot's --ssh option
-
-=head1 SYNOPSIS
-
-B<adduser-novaboot> --key KEY [--admin-id NAME] [adduser options] user
-
-=head1 DESCRIPTION
-
-B<adduser-novaboot> is a wrapper of L<adduser(8)> command that
-simplifies creation of user accounts for I<novaboot>'s --ssh option.
-The created account has its shell set to L<novaboot-shell(1)>. The
-command also creates a template of the configuration file, sets up
-administrator's SSH key in L<authorized_keys(5)> prepares directories
-and symlinks that for integration with TFTP server.
-
-=head2 Automatic power-off
-
-When your system uses L<systemd(1)>, you can configure a systemd
-service to automatically power-off the target after timeout. To enable
-this run:
-
- systemctl --user enable novaboot-delayed-power-off
-
-as the created user (e.g. via shell subcommand). To enable delayed
-power-off for all novaboot-shell account, run the follwing as root:
-
- systemctl --global enable novaboot-delayed-power-off
-
-Individual accounts may disable this global configuration by running:
-
- systemctl --user mask novaboot-delayed-power-off
-
-The power-off timeout is hardcoded in the B<novaboot-power-off@.timer>
-unit. To override the timeout, run C<systemctl edit
-novaboot-power-off@TARGET.timer> for your B<TARGET> and insert the
-following to the spawned editor:
-
- [Timer]
- OnActiveSec=30min
-
-=head1 OPTIONS
-
-=over 8
-
-=item --key KEY
-
-Mandatory argument specifying administrator's public SSH key (e.g.
-F<~/.ssh/id_rsa.pub>). The key will be copied to the created account's
-F<~/.ssh/authorized_keys> and marked with administrator flag.
-
-=item --admin-id NAME
-
-User name associated with the key. This user name is shown to
-connecting users when the target is occupied by the administrator.
-When omitted, I<admin> is used as the user name.
-
-=back
-
-=head1 AUTHORS
-
-Michal Sojka <sojkam1@fel.cvut.cz>
-
-Latest version can be found at
-L<https://github.com/wentasah/novaboot>.
-
-=cut
-EOF
--- /dev/null
+=encoding utf8
+
+=head1 NAME
+
+adduser-novaboot - create user account for use with novaboot's --ssh option
+
+=head1 SYNOPSIS
+
+B<adduser-novaboot> --key KEY [--admin-id NAME] [adduser options] user
+
+=head1 DESCRIPTION
+
+B<adduser-novaboot> is a wrapper of L<adduser(8)> command that
+simplifies creation of user accounts for I<novaboot>'s --ssh option.
+The created account has its shell set to L<novaboot-shell(1)>. The
+command also creates a template of the configuration file, sets up
+administrator's SSH key in L<authorized_keys(5)> prepares directories
+and symlinks that for integration with TFTP server.
+
+=head2 Automatic power-off
+
+When your system uses L<systemd(1)>, you can configure a systemd
+service to automatically power-off the target after timeout. To enable
+this run:
+
+ systemctl --user enable novaboot-delayed-power-off
+
+as the created user (e.g. via shell subcommand). To enable delayed
+power-off for all novaboot-shell account, run the follwing as root:
+
+ systemctl --global enable novaboot-delayed-power-off
+
+Individual accounts may disable this global configuration by running:
+
+ systemctl --user mask novaboot-delayed-power-off
+
+The power-off timeout is hardcoded in the B<novaboot-power-off@.timer>
+unit. To override the timeout, run C<systemctl edit
+novaboot-power-off@TARGET.timer> for your B<TARGET> and insert the
+following to the spawned editor:
+
+ [Timer]
+ OnActiveSec=30min
+
+=head1 OPTIONS
+
+=over 8
+
+=item --key KEY
+
+Mandatory argument specifying administrator's public SSH key (e.g.
+F<~/.ssh/id_rsa.pub>). The key will be copied to the created account's
+F<~/.ssh/authorized_keys> and marked with administrator flag.
+
+=item --admin-id NAME
+
+User name associated with the key. This user name is shown to
+connecting users when the target is occupied by the administrator.
+When omitted, I<admin> is used as the user name.
+
+=back
+
+=head1 AUTHORS
+
+Michal Sojka <sojkam1@fel.cvut.cz>
+
+Latest version can be found at
+L<https://github.com/wentasah/novaboot>.
+
+=cut
else
run_subcommand "$@"
fi
-exit
-
-: <<EOF
-=encoding utf8
-
-=head1 NAME
-
-novaboot-shell - provides novaboot with unified SSH-based interface for controlling target hardware
-
-=head1 SYNOPSIS
-
-B<novaboot-shell> -c "[command [arguments...]]"
-
-B<novaboot-shell> [command [arguments...]]
-
-B<ssh target@server> [command [arguments...]]
-
-=head1 DESCRIPTION
-
-B<novaboot-shell> provides L<novaboot(1)> with a unified SSH-based
-interface for controlling the target hardware. This simplifies
-client-side configuration, because clients typically need only the
-I<--ssh=...> option. B<novaboot-shell> is typically configured as a
-login shell of special user accounts associated with the target
-hardware (as set by L<adduser-novaboot(8)>). It ensures that users can
-perform only a limited set of actions (see L</COMMANDS> below) with
-the target and have no shell access on the server.
-
-=head1 COMMANDS
-
-=over 8
-
-=item console
-
-Connect to target console (usually serial line). When somebody is
-connected to the console, other users are blocked from controlling the
-target. Blocked users see a message indicating who blocks them.
-
-The user connected to the console is able to invoke other commands
-such as L</reset>, but only when the command is invoked via the same
-SSH connection. This can be accomplished by using SSH connection
-sharing, which is what L<novaboot(1)> uses (see I<-M> and I<-S> in
-L<ssh(1)>).
-
-This is the default command when no command is specified on the
-command line and C<default_cmd> is not set in the configuration file.
-
-=item reset
-
-Reset the target hardware.
-
-=item on
-
-Power on the target hardware.
-
-=item off
-
-Power off the target hardware.
-
-=item rsync [...]
-
-This command is not meant to be invoked directly by the user. It
-allows using L<rsync(1)> to copy files to the target, perhaps for TFTP
-server. The rsync command must be invoked as: C<rsync ...
-target@server:>, i.e. without specifying destination path. The files
-will be stored into I<$HOME/tftproot>.
-
-=item user <uernamename> [admin]
-
-User command is meant to be used with C<command=> option in SSH's
-L<authorized_keys(5)> file. It allows the shell to display
-human-readable names when printing information about who blocks the
-target. Then, the real command is taken from SSH_ORIGINAL_COMMAND
-environment variable.
-
-When "admin" is specified after the user name, this user is considered
-an administrator and is allowed to run L</add-key> and L</shell>
-commands.
-
-=item get-config
-
-Prints novaboot configuration options needed for the target. One
-option per line.
-
-=back
-
-=head2 Administration commands
-
-Only administrators (see L</user>) are allowed to execute these
-commands.
-
-=over 8
-
-=item add-key <username>
-
-Reads the SSH public key from standard input and adds it into in
-F<~/.ssh/authorized_keys>.
-
-Example: C<ssh target@server add-key johndoe < john_rsa.pub>
-
-=item shell
-
-Runs shell on the server. Useful for editing configuration file. It is
-better used with allocated pseudo-terminal.
-
-Example: C<ssh -t target@server shell>
-
-=back
-
-=head1 CONFIGURATION FILE
-
-B<novaboot-shell> reads configuration file from
-F<$HOME/.novaboot-shell>. It can define values for the following
-variables in the shell syntax.
-
-=over 8
-
-=item console_cmd
-
-Command to C<exec> that connects to target's console.
-
-Note that if you need more complex behaviour of the console command,
-e.g., different behaviour for different users (distinguished by the
-value of C<$NB_USER> variable), you can set this variable to a name of
-a shell function, which you define in the configuration file and
-implement the complex behaviour there.
-
-=item reset_cmd
-
-Command to C<exec> that resets the Target.
-
-=item on_cmd
-
-Command to C<exec> that powers the target on.
-
-=item off_cmd
-
-Command to C<exec> that powers the target off.
-
-=item target_config
-
-Novaboot command line options that specify which boot loader is used
-by the target (L<novaboot(1)> rejects other, possibly dangerous, options).
-Each option is on its own line and no quoting, escaping or stripping
-is performed on the values.
-
-Example:
-
- target_config="\
- --uboot=(uboot)
- --uboot-init=setenv serverip 192.168.1.1; setenv ipaddr 192.168.1.10
- --uboot-addr=kernel=0x8100000
- --uboot-addr=fdt=0x83000000
- --uboot-addr=ramdisk=0x83100000
- "
-
-=item default_cmd
-
-If set, this command is executed when no command is specified on the
-command line. If not set, C<console_cmd> is executed instead.
-
-As F<novaboot> (client) always uses the C<console> command to connect
-to the console, C<default_cmd> can be used to boot the target with
-some default configuration for users who do not use F<novaboot> client
-to boot their own configuration. For example, C<default_cmd> can be
-set to execute a novaboot script.
-
-In other words, C<ssh board@host> boots the board in the default
-configuration, whereas C<novaboot --ssh=board@host ...> boots the
-board as configured in C<...>.
-
-=back
-
-=head1 AUTHORS
-
-Michal Sojka <sojkam1@fel.cvut.cz>
-
-Latest version can be found at
-L<https://github.com/wentasah/novaboot>.
-
-=cut
-EOF
--- /dev/null
+=encoding utf8
+
+=head1 NAME
+
+novaboot-shell - provides novaboot with unified SSH-based interface for controlling target hardware
+
+=head1 SYNOPSIS
+
+B<novaboot-shell> -c "[command [arguments...]]"
+
+B<novaboot-shell> [command [arguments...]]
+
+B<ssh target@server> [command [arguments...]]
+
+=head1 DESCRIPTION
+
+B<novaboot-shell> provides L<novaboot(1)> with a unified SSH-based
+interface for controlling the target hardware. This simplifies
+client-side configuration, because clients typically need only the
+I<--ssh=...> option. B<novaboot-shell> is typically configured as a
+login shell of special user accounts associated with the target
+hardware (as set by L<adduser-novaboot(8)>). It ensures that users can
+perform only a limited set of actions (see L</COMMANDS> below) with
+the target and have no shell access on the server.
+
+=head1 COMMANDS
+
+=over 8
+
+=item console
+
+Connect to target console (usually serial line). When somebody is
+connected to the console, other users are blocked from controlling the
+target. Blocked users see a message indicating who blocks them.
+
+The user connected to the console is able to invoke other commands
+such as L</reset>, but only when the command is invoked via the same
+SSH connection. This can be accomplished by using SSH connection
+sharing, which is what L<novaboot(1)> uses (see I<-M> and I<-S> in
+L<ssh(1)>).
+
+This is the default command when no command is specified on the
+command line and C<default_cmd> is not set in the configuration file.
+
+=item reset
+
+Reset the target hardware.
+
+=item on
+
+Power on the target hardware.
+
+=item off
+
+Power off the target hardware.
+
+=item rsync [...]
+
+This command is not meant to be invoked directly by the user. It
+allows using L<rsync(1)> to copy files to the target, perhaps for TFTP
+server. The rsync command must be invoked as: C<rsync ...
+target@server:>, i.e. without specifying destination path. The files
+will be stored into I<$HOME/tftproot>.
+
+=item user <uernamename> [admin]
+
+User command is meant to be used with C<command=> option in SSH's
+L<authorized_keys(5)> file. It allows the shell to display
+human-readable names when printing information about who blocks the
+target. Then, the real command is taken from SSH_ORIGINAL_COMMAND
+environment variable.
+
+When "admin" is specified after the user name, this user is considered
+an administrator and is allowed to run L</add-key> and L</shell>
+commands.
+
+=item get-config
+
+Prints novaboot configuration options needed for the target. One
+option per line.
+
+=back
+
+=head2 Administration commands
+
+Only administrators (see L</user>) are allowed to execute these
+commands.
+
+=over 8
+
+=item add-key <username>
+
+Reads the SSH public key from standard input and adds it into in
+F<~/.ssh/authorized_keys>.
+
+Example: C<ssh target@server add-key johndoe < john_rsa.pub>
+
+=item shell
+
+Runs shell on the server. Useful for editing configuration file. It is
+better used with allocated pseudo-terminal.
+
+Example: C<ssh -t target@server shell>
+
+=back
+
+=head1 CONFIGURATION FILE
+
+B<novaboot-shell> reads configuration file from
+F<$HOME/.novaboot-shell>. It can define values for the following
+variables in the shell syntax.
+
+=over 8
+
+=item console_cmd
+
+Command to C<exec> that connects to target's console.
+
+Note that if you need more complex behaviour of the console command,
+e.g., different behaviour for different users (distinguished by the
+value of C<$NB_USER> variable), you can set this variable to a name of
+a shell function, which you define in the configuration file and
+implement the complex behaviour there.
+
+=item reset_cmd
+
+Command to C<exec> that resets the Target.
+
+=item on_cmd
+
+Command to C<exec> that powers the target on.
+
+=item off_cmd
+
+Command to C<exec> that powers the target off.
+
+=item target_config
+
+Novaboot command line options that specify which boot loader is used
+by the target (L<novaboot(1)> rejects other, possibly dangerous, options).
+Each option is on its own line and no quoting, escaping or stripping
+is performed on the values.
+
+Example:
+
+ target_config="\
+ --uboot=(uboot)
+ --uboot-init=setenv serverip 192.168.1.1; setenv ipaddr 192.168.1.10
+ --uboot-addr=kernel=0x8100000
+ --uboot-addr=fdt=0x83000000
+ --uboot-addr=ramdisk=0x83100000
+ "
+
+=item default_cmd
+
+If set, this command is executed when no command is specified on the
+command line. If not set, C<console_cmd> is executed instead.
+
+As F<novaboot> (client) always uses the C<console> command to connect
+to the console, C<default_cmd> can be used to boot the target with
+some default configuration for users who do not use F<novaboot> client
+to boot their own configuration. For example, C<default_cmd> can be
+set to execute a novaboot script.
+
+In other words, C<ssh board@host> boots the board in the default
+configuration, whereas C<novaboot --ssh=board@host ...> boots the
+board as configured in C<...>.
+
+=back
+
+=head1 AUTHORS
+
+Michal Sojka <sojkam1@fel.cvut.cz>
+
+Latest version can be found at
+L<https://github.com/wentasah/novaboot>.
+
+=cut
projects / novaboot.git / commitdiff