sysmo-bts
/
barebox
9
0
Fork 0
Code Releases Activity

doc: unify documentation for 'edit' 

Signed-off-by: Robert Schwebel <r.schwebel@pengutronix.de>
This commit is contained in:
Robert Schwebel 2010-07-12 19:48:18 +02:00 committed by Sascha Hauer
parent caaab18471
commit 7f89e29fac
1 changed files with 14 additions and 24 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

38
commands/edit.c
View File

@ -550,35 +550,25 @@ out:
static const char *edit_aliases[] = { "sedit", NULL};
static const __maybe_unused char cmd_edit_help[] =
"Usage: (s)edit <file>\n"
"This is a very small editor. Its only features are moving the cursor with\n"
"the usual keys and typing characters.\n"
"<ctrl-c> quits the editor without saving,\n"
"<ctrl-d> quits the editor with saving the current file.\n"
"\n"
"If called as sedit the editor uses ansi codes to scroll the screen.\n";
BAREBOX_CMD_HELP_START(edit)
BAREBOX_CMD_HELP_USAGE("(s)edit <file>\n")
BAREBOX_CMD_HELP_SHORT("A small editor. <ctrl-c> is exit, <ctrl-d> exit-with-save.\n")
BAREBOX_CMD_HELP_END
static const __maybe_unused char cmd_edit_usage[] = "edit a file";
/**
* @page edit_command
<p> Barebox contains a small text editor which can be used to edit
config files in /env. You can move the cursor around with the arrow keys
and type characters. </p>
If called as sedit, the editor uses ansi codes to scroll the screen.
*/
BAREBOX_CMD_START(edit)
.cmd = do_edit,
.aliases = edit_aliases,
.usage = cmd_edit_usage,
.usage = "Usage: (s)edit <file>",
BAREBOX_CMD_HELP(cmd_edit_help)
BAREBOX_CMD_END
/**
* @page edit_command edit (editor)
*
* Usage is: [s]edit \<file\>
*
* This is a very small editor. It's only features are moving the cursor with
* the usual keys and typing characters.
*
* \b \<ctrl-c\> quits the editor without saving,\n
* \b \<ctrl-d\> quits the editor with saving the current file.
*
* If called as \c sedit the editor uses ansi codes to scroll the screen.
*/