From dc211893b12d401c5d97c70fa409e500e761c413 Mon Sep 17 00:00:00 2001 From: "Stephen M. Coakley" Date: Sat, 17 Jun 2017 16:19:36 -0500 Subject: [PATCH] Improve docs --- docs/cli/install.adoc | 13 +++++++++---- docs/cli/new.adoc | 7 +++++-- docs/cli/omf.adoc | 8 ++++---- docs/cli/reload.adoc | 4 +++- docs/cli/remove.adoc | 3 +++ docs/cli/repositories.adoc | 6 ++++-- docs/cli/update.adoc | 14 +++++++++----- 7 files changed, 37 insertions(+), 18 deletions(-) diff --git a/docs/cli/install.adoc b/docs/cli/install.adoc index 6adc132..7847789 100644 --- a/docs/cli/install.adoc +++ b/docs/cli/install.adoc @@ -1,18 +1,23 @@ Install one or more packages. == USAGE + omf install [ [...]] Install package by name or URL omf install Install missing packages from bundle - omf install ( | ) Install package by name or URL == DESCRIPTION -You can install packages directly by URL via omf install URL. +Installs packages identified by each given. A package can be specified either by name or by a URL. -When called without arguments, install missing packages from bundle. +When specifying a package by name, the package name is searched for in each package repository currently installed. The first matching package is selected and downloaded. See `omf help repositories` for more information about repositories. + +When a package is specified by URL, OMF assumes the URL points to a Git repository and installs the package by cloning the repository. + +When called without arguments, any packages specified in your bundle file that are missing will be installed. == EXAMPLES - omf install omf install brew omf install https://github.com/oh-my-fish/plugin-brew + omf install brew spark + omf install == ALIASES *omf i*, *omf in*, *omf get* diff --git a/docs/cli/new.adoc b/docs/cli/new.adoc index d5f86b7..9a58389 100644 --- a/docs/cli/new.adoc +++ b/docs/cli/new.adoc @@ -1,10 +1,13 @@ Create a new package from a template. == USAGE - omf new (_pkg_ | _theme_) + omf new (_plugin_ | _theme_) + +== DESCRIPTION +Creates a new package skeleton under `$OMF_CONFIG` named . The type of package is determined by the first argument. == EXAMPLES - omf new pkg mypkg + omf new plugin myplugin omf new theme mytheme == ALIASES diff --git a/docs/cli/omf.adoc b/docs/cli/omf.adoc index 9982cd1..d789077 100644 --- a/docs/cli/omf.adoc +++ b/docs/cli/omf.adoc @@ -7,20 +7,20 @@ Oh My Fish! - the fish shell framework Provides options to list, download and remove packages, update the framework, create a new package, etc. == COMMANDS -<>:: Change directory to plugin/theme directory. +<>:: Change to root or package directory. <>:: Get or change the update channel. <>:: Show information about a package. <>:: Uninstall Oh My Fish. <>:: Troubleshoot Oh My Fish. -<>:: Shows help about a specific action. +<>:: Shows help about a command. <>:: Install one or more packages. <>:: List installed packages. <>:: Create a new package from a template. <>:: Reload the current shell. -<>:: Remove a theme or package. +<>:: Remove a package. <>:: Manage package repositories. <>:: Search for a package or theme. -<>:: List / Use themes. +<>:: Install and list themes. <>:: Update Oh My Fish. <>:: Display version and exit. diff --git a/docs/cli/reload.adoc b/docs/cli/reload.adoc index 4c45b45..0d0c251 100644 --- a/docs/cli/reload.adoc +++ b/docs/cli/reload.adoc @@ -4,4 +4,6 @@ Reload the current shell. omf reload == DESCRIPTION -Reload Oh My Fish and all plugins by using `exec` to replace current shell process with a brand new process. This command tries to be as safe as possible, mitigating side-effects caused by exec and preventing the reload in case of background processes. +Reload Oh My Fish and all plugins by using `exec` to replace current shell process with a brand new process. + +This command tries to be as safe as possible, mitigating side-effects caused by exec and preventing the reload in case of background processes. diff --git a/docs/cli/remove.adoc b/docs/cli/remove.adoc index dacd0d6..c1798fd 100644 --- a/docs/cli/remove.adoc +++ b/docs/cli/remove.adoc @@ -3,6 +3,9 @@ Remove a package. == USAGE omf remove +== DESCRIPTION +Removes an installed package identified by . + == EXAMPLES omf remove brew omf remove l diff --git a/docs/cli/repositories.adoc b/docs/cli/repositories.adoc index 6da0907..b216d8d 100644 --- a/docs/cli/repositories.adoc +++ b/docs/cli/repositories.adoc @@ -6,14 +6,16 @@ Manage user-installed package repositories. omf repositories (rm | remove) [] == DESCRIPTION -Package repositories are where packages come from used by commands like omf install. By default the official repository is always installed and available. +Provides commands for viewing and managing package repositories for the current user. + +Package repositories are where named packages come from used by commands like `omf install`. By default the official repository is always installed and available. == SUBCOMMANDS list, ls:: List installed repositories. add:: - Add a package repository. + Add a package repository located at . If is not specified, the default branch of `master` is assumed. remove, rm:: Remove a package repository. diff --git a/docs/cli/update.adoc b/docs/cli/update.adoc index 7ff1909..da332c1 100644 --- a/docs/cli/update.adoc +++ b/docs/cli/update.adoc @@ -1,14 +1,18 @@ -Update Oh My Fish. +Update Oh My Fish and packages. == USAGE omf update [ [ [...]]] == DESCRIPTION -Update Oh My Fish, all package repositories, and all installed packages. +Updates Oh My Fish, package repositories, and installed packages. -* When called without arguments, updates the core framework and all installed packages. -* You can choose to update only the core, by running `omf update omf`. -* For selective package update, list only the names of packages you wish to update. You may still include "omf" in the list to update the core as well. +Each package name that is given will be updated. For example, to update the packages `bobthefish` and `direnv`, run: + + omf update bobthefish direnv + +The special package name `omf` will cause Oh My Fish to update itself. This can be combined with other package names. + +If no arguments are given, all installed packages will be updated along with Oh My Fish. == ALIASES *omf u*, *omf up*