update 'triton pkgs -h' help output to mention support for field filters

This commit is contained in:
Trent Mick 2015-12-17 15:39:32 -08:00
parent 1c624f5a27
commit baddfbf814
2 changed files with 27 additions and 19 deletions

View File

@ -132,6 +132,8 @@ do_images.help = (
'Usage:\n' + 'Usage:\n' +
' {{name}} images [<options>] [<filters>]\n' + ' {{name}} images [<options>] [<filters>]\n' +
'\n' + '\n' +
'{{options}}' +
'\n' +
'Filters:\n' + 'Filters:\n' +
' FIELD=VALUE Field equality filter. Supported fields: \n' + ' FIELD=VALUE Field equality filter. Supported fields: \n' +
' account, owner, state, name, os, and type.\n' + ' account, owner, state, name, os, and type.\n' +
@ -147,9 +149,7 @@ do_images.help = (
' image with a state *other* than "active".\n' + ' image with a state *other* than "active".\n' +
' pubdate Short form of "published_at" with just the date\n' + ' pubdate Short form of "published_at" with just the date\n' +
' pub Short form of "published_at" elliding milliseconds.\n' + ' pub Short form of "published_at" elliding milliseconds.\n' +
' size The number of bytes of the image file (files.0.size)\n' + ' size The number of bytes of the image file (files.0.size)\n'
'\n' +
'{{options}}'
/* END JSSTYLED */ /* END JSSTYLED */
); );

View File

@ -153,24 +153,32 @@ do_packages.options = [
} }
]); ]);
do_packages.help = ( do_packages.help = [
/* BEGIN JSSTYLED */ /* BEGIN JSSTYLED */
'List packgaes.\n' 'List packgaes.',
+ '\n' '',
+ 'Usage:\n' 'Usage:',
+ ' {{name}} packages\n' ' {{name}} packages [<filters>]',
+ '\n' '',
+ '{{options}}' '{{options}}',
+ '\n' 'Filters:',
+ 'Notes on some fields:\n' ' FIELD=VALUE Field equality filter. Supported fields: ',
+ '- The "memory" (a.k.a. RAM), "swap", and "disk" fields are shown in\n' ' account, owner, state, name, os, and type.',
+ ' more human readable units in tabular output (i.e. if neither "-p" nor\n' ' FIELD=true|false Field boolean filter. Supported fields: public.',
+ ' "-j" is specified.\n' ' FIELD=~SUBSTRING Field substring filter. Supported fields: name',
+ '- The "vcpus" field is only relevant for KVM instances. It is therefore\n' '',
+ ' typically set to zero for packages not intended for KVM usage. This\n' 'Notes on some fields:',
+ ' zero is shown as "-" in tabular output.\n' '- The "memory" (a.k.a. RAM), "swap", and "disk" fields are shown in',
' more human readable units in tabular output (i.e. if neither "-p" nor',
' "-j" is specified.',
'- The "vcpus" field is only relevant for KVM instances. It is therefore',
' typically set to zero for packages not intended for KVM usage. This',
' zero is shown as "-" in tabular output.',
'',
'Examples:',
' {{name}} packages memory=8192 # list packages with 8G RAM'
/* END JSSTYLED */ /* END JSSTYLED */
); ].join('\n');
do_packages.aliases = ['pkgs']; do_packages.aliases = ['pkgs'];