1 /* Copyright (C) 2008 The Android Open Source Project 2 ** 3 ** This software is licensed under the terms of the GNU General Public 4 ** License version 2, as published by the Free Software Foundation, and 5 ** may be copied, distributed, and modified under those terms. 6 ** 7 ** This program is distributed in the hope that it will be useful, 8 ** but WITHOUT ANY WARRANTY; without even the implied warranty of 9 ** MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 10 ** GNU General Public License for more details. 11 */ 12 #ifndef _ANDROID_HELP_H 13 #define _ANDROID_HELP_H 14 15 #include "android/utils/stralloc.h" 16 17 /* appends the list of options with a small description to a dynamic string */ 18 extern void android_help_list_options( stralloc_t* out ); 19 20 /* output main help screen into a single dynamic string */ 21 extern void android_help_main( stralloc_t* out ); 22 23 /* output all help into a single dynamic string */ 24 extern void android_help_all( stralloc_t* out ); 25 26 /* appends the help for a given command-line option into a dynamic string 27 * returns 0 on success, or -1 on error (i.e. unknown option) 28 */ 29 extern int android_help_for_option( const char* option, stralloc_t* out ); 30 31 /* appends the help for a given help topic into a dynamic string 32 * returns 0 on success, or -1 on error (i.e. unknown topic) 33 */ 34 extern int android_help_for_topic( const char* topic, stralloc_t* out ); 35 36 #endif /* _ANDROID_HELP_H */ 37