summaryrefslogtreecommitdiff
path: root/include
diff options
context:
space:
mode:
authorDenis Vlasenko2007-09-25 18:35:28 +0000
committerDenis Vlasenko2007-09-25 18:35:28 +0000
commit6a5377ac14bec2f2ae62c4ec085ff3b149cc11ad (patch)
treebb2200121abb55f06facbe8793c649ae90f53717 /include
parentea7645bab62c6f68c755cf717662bceaa04858ed (diff)
downloadbusybox-6a5377ac14bec2f2ae62c4ec085ff3b149cc11ad.zip
busybox-6a5377ac14bec2f2ae62c4ec085ff3b149cc11ad.tar.gz
documentation bits in comments, no code changes
Diffstat (limited to 'include')
-rw-r--r--include/libbb.h6
1 files changed, 6 insertions, 0 deletions
diff --git a/include/libbb.h b/include/libbb.h
index 25b2e44..407b723 100644
--- a/include/libbb.h
+++ b/include/libbb.h
@@ -892,6 +892,12 @@ enum {
FOR_SHELL = DO_HISTORY | SAVE_HISTORY | TAB_COMPLETION | USERNAME_COMPLETION,
};
line_input_t *new_line_input_t(int flags);
+/* Returns:
+ * -1 on read errors or EOF, or on bare Ctrl-D.
+ * 0 on ctrl-C,
+ * >0 length of input string, including terminating '\n'
+ * [is this true? stores "" in 'command' if return value is 0 or -1]
+ */
int read_line_input(const char* prompt, char* command, int maxsize, line_input_t *state);
#else
int read_line_input(const char* prompt, char* command, int maxsize);