~sircmpwn/himitsu-ssh

01b863496c99328f00d377839dce05fd785c3f94 — Armin Preiml 3 months ago 5803a91
add himitsu-ssh.ini man page
3 files changed, 69 insertions(+), 2 deletions(-)

M Makefile
A docs/himitsu-ssh.ini.5.scd
M docs/hissh-agent.1.scd
M Makefile => Makefile +6 -0
@@ 29,6 29,7 @@ check:

DOCS=himitsu-ssh.5 \
	himitsu-ssh.7 \
	himitsu-ssh.ini.5 \
	hissh-import.1 \
	hissh-export.1 \
	hissh-agent.1


@@ 41,6 42,9 @@ himitsu-ssh.7: docs/himitsu-ssh.7.scd
himitsu-ssh.5: docs/himitsu-ssh.5.scd
	$(SCDOC) <$< >$@

himitsu-ssh.ini.5: docs/himitsu-ssh.ini.5.scd
	$(SCDOC) <$< >$@

hissh-import.1: docs/hissh-import.1.scd
	$(SCDOC) <$< >$@



@@ 62,6 66,7 @@ install:
	install -m755 hissh-export $(DESTDIR)$(BINDIR)/hissh-export
	install -m755 hissh-import $(DESTDIR)$(BINDIR)/hissh-import
	install -m644 himitsu-ssh.5 $(DESTDIR)$(MANDIR)/man5/himitsu-ssh.5
	install -m644 himitsu-ssh.ini.5 $(DESTDIR)$(MANDIR)/man5/himitsu-ssh.ini.5
	install -m644 himitsu-ssh.7 $(DESTDIR)$(MANDIR)/man7/himitsu-ssh.7
	install -m644 hissh-export.1 $(DESTDIR)$(MANDIR)/man1/hissh-export.1
	install -m644 hissh-import.1 $(DESTDIR)$(MANDIR)/man1/hissh-import.1


@@ 72,6 77,7 @@ uninstall:
	rm -f $(DESTDIR)$(BINDIR)/hissh-import
	rm -f $(DESTDIR)$(BINDIR)/hissh-export
	rm -f $(DESTDIR)$(MANDIR)/man5/himitsu-ssh.5
	rm -f $(DESTDIR)$(MANDIR)/man5/himitsu-ssh.ini.5
	rm -f $(DESTDIR)$(MANDIR)/man7/himitsu-ssh.7
	rm -f $(DESTDIR)$(MANDIR)/man1/hissh-import.1
	rm -f $(DESTDIR)$(MANDIR)/man1/hissh-export.1

A docs/himitsu-ssh.ini.5.scd => docs/himitsu-ssh.ini.5.scd +58 -0
@@ 0,0 1,58 @@
himitsu.ini(5)

# NAME

himitsu-ssh.ini - configuration file for *himitsu-ssh*(7)

# FILE FORMAT

The himitsu-ssh configuration file is an INI file. Each set of options is
grouped into sections, which are indicated by the section name surrounded by
square brackets (e.g. [remember]) on a line. Following each section, a set of
key/value pairs belonging to that section are provided. The keys are separated
from the values by an equal symbol (*=*).

# APPLICATION USAGE

The set of configuration parameters recognized by the himitsu-ssh distribution
are specified below.

## REMEMBER

Options related to remembering consent are placed into the [remember] section.
The available options are:

*persist*
	Remember options that should be shown by the prompter when asking to
	persist access of the _proto=ssh_ query. Leave blank, if consent
	should not be remembered.
	
	The value is a comma separated list of remember options. Possible
	options are _session_, _skip_, _refuse_ or a timeout in seconds as
	integer. _session_ will remember consent until himitsu or hissh-agent
	terminates. _skip_ will postpone the decision until the next prompt
	and _refuse_ will deny the request and future requests won't be shown.

	The first value will be considered as the default one by the prompter.

	Default value, if the option is omitted: session,300,refuse

*disclose*
	Remember options that the prompter should show when asking for private
	key disclosure in e.g. signing operations. Leave blank, if not
	applicable.

	Uses the same syntax as the *persist* option.

	Default value, if the option is omitted: skip,session,300

# SEE ALSO

*himitsu-ssh*(7)

# AUTHORS

Maintained by Drew DeVault <sir@cmpwn.com>, who is assisted by other
contributors. Up-to-date source code can be found at
https://git.sr.ht/~sircmpwn/himitsu, and bugs/patches can be submitted by email
to ~sircmpwn/himitsu-devel@lists.sr.ht.

M docs/hissh-agent.1.scd => docs/hissh-agent.1.scd +5 -2
@@ 25,13 25,16 @@ new keys, see *hissh-import*(1). It is recommended to run these commands for
your entire session using a suitable system-specific service manager or startup
script.

The agent can be configured using a *himitsu-ssh.ini*(5) config file stored in
$XDG_CONFIG_HOME/himitsu-ssh/config.ini.

# SEE ALSO

*hissh-import*(1), *hissh-export*(1)
*hissh-import*(1), *hissh-export*(1) *himitsu-ssh.ini*(5)

# AUTHORS

Maintained by Drew DeVault <sir@cmpwn.com>, who is assited by other
Maintained by Drew DeVault <sir@cmpwn.com>, who is assisted by other
contributors. Up-to-date source code can be found at
https://git.sr.ht/~sircmpwn/himitsu-ssh, and bugs/patches can be submitted by
email to ~sircmpwn/himitsu-devel@lists.sr.ht.