diff options
authorAvatar Ciaran McCreesh <ciaran.mccreesh@googlemail.com> 2007-10-25 05:37:10 +0000
committerAvatar Ciaran McCreesh <ciaran.mccreesh@googlemail.com> 2007-10-25 05:37:10 +0000
commit7b2c837862aaa4a0fb320f59dae9ba3e252f1fa2 (patch)
parente99bd9d1357923e87db3979be3b9eff4b333c3c0 (diff)
Add some examples to 'man paludis'
2 files changed, 58 insertions, 1 deletions
diff --git a/src/clients/paludis/command_line.cc b/src/clients/paludis/command_line.cc
index 9e6c72c..47f371a 100644
--- a/src/clients/paludis/command_line.cc
+++ b/src/clients/paludis/command_line.cc
@@ -71,7 +71,8 @@ CommandLine::CommandLine() :
a_no_colour(&general_args, "no-colour", '\0', "Do not use colour"),
a_no_color(&a_no_colour, "no-color"),
a_environment(&general_args, "environment", 'E', "Environment specification (class:suffix, both parts optional)"),
- a_resume_command_template(&general_args, "resume-command-template", '\0', "Save the resume command to a file. If the filename contains 'XXXXXX', use mkstemp(3) to generate the filename"),
+ a_resume_command_template(&general_args, "resume-command-template", '\0',
+ "Save the resume command to a file. If the filename contains 'XXXXXX', use mkstemp(3) to generate the filename"),
query_args(this, "Query options",
"Options which are relevant for --query."),
@@ -151,6 +152,61 @@ CommandLine::CommandLine() :
add_environment_variable("PALUDIS_OPTIONS", "Default command-line options.");
+ add_example(
+ "paludis --sync",
+ "Sync all syncable repositories, and perform any necessary cache updates.");
+ add_example(
+ "paludis --install --pretend world",
+ "Show available updates for packages in the 'world' set (which contains all packages that "
+ "have been explicitly installed as targets, along with the 'system' set), along with runtime "
+ "dependencies of packages therein recursively.");
+ add_example(
+ "paludis --install world",
+ "...and, having checked the output above, perform the install.");
+ add_example(
+ "paluds --install --continue-on-failure if-satisfied world",
+ "...and continue as far as possible even after errors are encountered.");
+ add_example(
+ "paludis --install --pretend --dl-reinstall if-use-changed world",
+ "...also reinstall packages whose use settings have changed.");
+ add_example(
+ "paludis --install --pretend --dl-reinstall-scm weekly",
+ "...also reinstall any scm (cvs, svn, ...) package that was installed over a week ago.");
+ add_example(
+ "paludis --install --pretend x11-wm/fluxbox",
+ "Show what would be done to install a single package, along with all its dependencies, "
+ "whilst recursively updating runtime dependencies.");
+ add_example(
+ "paludis --install --pretend fluxbox",
+ "...as above, if the package name is unambiguous.");
+ add_example(
+ "paludis --install fluxbox",
+ "...and perform the install, and add the package to the 'world' set when done.");
+ add_example(
+ "paludis --install --preserve-world fluxbox",
+ "...or don't add the package to the 'world' set.");
+ add_example(
+ "paludis --install --pretend --dl-upgrade as-needed fluxbox",
+ "...only update dependencies where required.");
+ add_example(
+ "paludis --install --pretend =x11-wm/fluxbox-1.0.0",
+ "...specifying an exact version (which also prevents the package from being added to 'world').");
+ add_example(
+ "paludis --uninstall app-editors/emacs",
+ "Uninstall a package.");
+ add_example(
+ "paludis --uninstall --pretend --with-dependencies app-editors/emacs",
+ "Uninstall a package, along with any packages depending upon it.");
+ add_example(
+ "paludis --uninstall --pretend --with-dependencies --with-unused-dependencies app-editors/emacs",
+ "...and also any packages that are only installed to satisfy that package's dependencies.");
+ add_example(
+ "paludis --uninstall --pretend --permit-unsafe-uninstalls app-editors/emacs",
+ "...uninstall, even if the package is required by another installed package.");
+ add_example(
+ "paludis --uninstall-unused --pretend",
+ "Uninstall all unused packages.");
diff --git a/src/clients/paludis/man_paludis.cc b/src/clients/paludis/man_paludis.cc
index 5916717..43fa418 100644
--- a/src/clients/paludis/man_paludis.cc
+++ b/src/clients/paludis/man_paludis.cc
@@ -76,3 +76,4 @@ main(int argc, char * argv[])