diff --git a/Makefile-man.am b/Makefile-man.am index b3881526..c37272a6 100644 --- a/Makefile-man.am +++ b/Makefile-man.am @@ -41,6 +41,10 @@ if BUILDOPT_FUSE man1_files += rofiles-fuse.1 endif +if ENABLE_EXPERIMENTAL_API +man1_files += ostree-find-remotes.1 +endif + man5_files = ostree.repo.5 ostree.repo-config.5 man1_MANS = $(addprefix man/,$(man1_files)) diff --git a/man/ostree-find-remotes.xml b/man/ostree-find-remotes.xml new file mode 100644 index 00000000..ed137324 --- /dev/null +++ b/man/ostree-find-remotes.xml @@ -0,0 +1,131 @@ + + + + + + + + + ostree find-remotes + OSTree + + + + Developer + Matthew + Leeds + matthew.leeds@endlessm.com + + + + + + ostree find-remotes + 1 + + + + ostree-find-remotes + Find remotes to serve the given refs + + + + + ostree find-remotes OPTIONS COLLECTION-ID REF COLLECTION-ID REF + + + + + Description + + + + OSTree has the ability do pulls not just from configured remote + servers but also from peer computers on the LAN and from mounted + filesystems such as USB drives. Currently this requires compiling + OSTree with experimental API enabled, and it requires the use of + collection IDs and GPG verification. + + + The find-remotes command searches for remotes + which claim to provide one or more of the given COLLECTION-ID REF + pairs and prints information about them, with remotes sorted by + latency (Mounts > LAN > Internet). By default, OSTree searches for + remotes in configuration files, on mounted filesystems (in a + well-known location), and on the LAN using Avahi. Searching for LAN + remotes requires OSTree to have been compiled with Avahi support, + and it requires an Avahi daemon to be running. You can override the + default set of finders (sources for remotes) using the + option documented below. + + + + + Options + + + + + + + Do not invoke fsync(). + + + + + + =FINDERS + + + Use the specified comma separated list of finders rather than + the default set. Possible values: config, + lan, and mount (or any + combination thereof). + + + + + + + + Pull the most recent commit found for each ref. + + + + + + + + Example + $ ostree find-remotes --finders=mount,lan com.exampleos.Os exampleos/x86_64/standard + +Result 0: http://10.0.64.202:43381/0 + - Finder: OstreeRepoFinderAvahi + - Keyring: exampleos.trustedkeys.gpg + - Priority: 60 + - Summary last modified: 2018-01-12T19:00:28Z + - Refs: + - (com.exampleos.Os, exampleos/x86_64/standard) = c91acd964b3fda561b87bfb7f7c80e36220d76b567f0ce90c0e60742ef33c360 + +1/1 refs were found. + + + diff --git a/man/ostree.xml b/man/ostree.xml index 940d81d7..05b02c5d 100644 --- a/man/ostree.xml +++ b/man/ostree.xml @@ -290,6 +290,15 @@ Boston, MA 02111-1307, USA. + + ostree-fsck1 diff --git a/src/ostree/ot-builtin-find-remotes.c b/src/ostree/ot-builtin-find-remotes.c index b99f6e6a..3df84a4f 100644 --- a/src/ostree/ot-builtin-find-remotes.c +++ b/src/ostree/ot-builtin-find-remotes.c @@ -164,7 +164,6 @@ validate_finders_list (char **finders, return TRUE; } -/* TODO: Add a man page. */ gboolean ostree_builtin_find_remotes (int argc, char **argv,