Template:Unmerge/doc

From Gentoo Wiki
Jump to:navigation Jump to:search
Note
This page is a template. It contains some standardized, often used text, which can be transcluded inside other pages. As this template is widely used in our wiki, it may be protected in which case only staff members can change it. Use the discussion page to propose enhancements or fixes, or to voice your opinion.

Similar to the {{Emerge}} template, this template shows a root level terminal prompt pre-formatted with the emerge --ask --depclean command. It is helpful when referencing software removal.

Parameters

Parameter name Required? Default value Description
Anonymous parameter 1 Yes (n/a) One or more package names (or atoms). Use {{=}} or {{!}} in place of the characters = or |.
params+ No (n/a) emerge command parameters to be displayed in addition to the default --ask --depclean.
params No (n/a) emerge command parameters to be displayed instead of the default --ask --depclean.
output No (n/a) The command's output.

Usage

See the template's testcases:


Parameter: unnamed
Wiki code {{Unmerge|sys-apps/portage}}

Main version
root #emerge --ask --depclean --verbose sys-apps/portage
Sandbox version
root #emerge --ask sys-apps/portage
Parameter: unnamed with the special character "="
Wiki code {{Unmerge|{{=}}sys-apps/portage-1.2.3}}

Main version
root #emerge --ask --depclean --verbose =sys-apps/portage-1.2.3
Sandbox version
root #emerge --ask =sys-apps/portage-1.2.3
Parameter: unnamed (multiple packages)
Wiki code {{Unmerge|sys-apps/portage sys-apps/portage2 sys-apps/portage3}}

Main version
root #emerge --ask --depclean --verbose sys-apps/portage sys-apps/portage2 sys-apps/portage3
Sandbox version
root #emerge --ask sys-apps/portage sys-apps/portage2 sys-apps/portage3
Parameter: params+
Wiki code {{Unmerge |sys-apps/portage |params+=--oneshot }}

Main version
root #emerge --ask --depclean --verbose --oneshot sys-apps/portage
Sandbox version
root #emerge --ask --oneshot sys-apps/portage
Parameter: params
Wiki code {{Unmerge |sys-apps/portage |params=--pretend --nospinner }}

Main version
root #emerge --pretend --nospinner sys-apps/portage
Sandbox version
root #emerge --pretend --nospinner sys-apps/portage
Parameter: output
Wiki code {{Unmerge|sys-apps/portage|output=<pre> Some output </pre>}}

Main version
root #emerge --ask --depclean --verbose sys-apps/portage
Some output
Sandbox version
root #emerge --ask sys-apps/portage
Some output
Parameter: unnamed & {{Package}}
Wiki code {{Unmerge|{{Package|sys-apps/portage}}}}

Main version
root #emerge --ask --depclean --verbose sys-apps/portage
Sandbox version
root #emerge --ask sys-apps/portage


See also