From f8b47031fd65b9055e6a89a961466bdb367cd710 Mon Sep 17 00:00:00 2001 From: Timo Weingärtner Date: Tue, 18 Feb 2014 18:25:08 +0100 Subject: Documentation update, license clarification use pandoc for manpage generation, drop now-redundant README --- README | 41 ----------------------------------------- 1 file changed, 41 deletions(-) delete mode 100644 README (limited to 'README') diff --git a/README b/README deleted file mode 100644 index 1953dd1..0000000 --- a/README +++ /dev/null @@ -1,41 +0,0 @@ -Writing a source definition: -============================ - -Place a file in /etc/openssh-known-hosts/sources. Its name must follow -run-parts' conventions. - -Basic variables: - * PLUGIN: name of the plugin to use - * EXIT_IGNORE: space-seperated list of exitcodes which should be ignored, no - update is performed for this source then (optional) - -The rest of the variables is plugin-specific. - -For examples see /usr/share/doc/openssh-known-hosts/examples/*. - -Writing a hostname filter: -========================== - -Place a file $source.filter next to your $source in -/etc/openssh-known-hosts/sources. - -Each line shall contain a rule consisting of an action, a space and a pattern. -The first rule with a matching pattern decides: If the action starts with a, -o, p or y (for accept, admit, allow, ok, pass, permit, print, yes, ...) the -hostname will be used, otherwise it is discarded. If a key has no hostnames -left it is discarded as a whole. - -An example filter can be found in -/usr/share/doc/openssh-known-hosts/examples/curl.filter. - -Writing a plugin: -================= - -Place an executeable in /usr/local/share/openssh-known-hosts/plugins. Your -plugin gets the variables set in the source definition in its environment. The -working directory will be set to the source's cache directory. All your plugin -has to do is to create a file named "new". "current" must not be touched but -can be used as a hint to skip downloading the same file again. stdout and -stderr will be connected to "log", which will be output on error. You needn't -create "new" if it would be identical to "current". - -- cgit v1.2.3