Commit b5516f331d23963e0a76fad72765336b87b01a6d

Authored by Shrikant Sharat
1 parent d6d8e5504b

Group and improve the docs for `antigen use` command.

Showing 1 changed file with 15 additions and 5 deletions Side-by-side Diff

... ... @@ -348,7 +348,17 @@ clones. If the `--force` argument is given, then this confirmation is not asked.
348 348 It straight away deletes all the unused clones. This option makes this command
349 349 usable in a non-interactive fashion.
350 350  
351   -### antigen use oh-my-zsh
  351 +### antigen use
  352 +
  353 +This command lets you load any (supported) zsh pre-packaged framework, like
  354 +oh-my-zsh. Usage is
  355 +
  356 + antigen use oh-my-zsh
  357 +
  358 +Additional arguments may be present depending on the framework you are
  359 +`use`-ing. Here are the supported frameworks.
  360 +
  361 +#### oh-my-zsh
352 362  
353 363 This is (almost) the same as
354 364  
... ... @@ -365,16 +375,14 @@ oh-my-zsh repo or a fork of that repo. If you want to specify the `url` too,
365 375 then you can't use the `antigen use oh-my-zsh` short cut. You have to do that
366 376 directly with the `antigen bundle` command.
367 377  
368   -This is present to ease dealing with oh-my-zsh plugins.
369   -
370 378 Use
371 379  
372 380 antigen use oh-my-zsh
373 381  
374   -in your `.zshrc`, before any `antigen bundle` declarations. It takes no
  382 +in your `.zshrc`, before any `antigen bundle` declarations. It takes no further
375 383 arguments.
376 384  
377   -### antigen use prezto <sup>&alpha;</sup>
  385 +#### prezto
378 386  
379 387 This is (almost, but not quite) the same as doing,
380 388  
... ... @@ -384,6 +392,8 @@ That is, initializes the canonical repo of the prezto framework. Please note
384 392 that prezto support is very new and experimental in antigen. If you find any
385 393 bugs, please report over on github issues.
386 394  
  395 +Takes no further arguments.
  396 +
387 397 ### antigen theme
388 398  
389 399 Used for switching the prompt theme. Invoke it with the name of the theme you