aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorRafael G. Martins <rafael@rafaelmartins.eng.br>2017-11-19 00:00:15 +0100
committerRafael G. Martins <rafael@rafaelmartins.eng.br>2017-11-19 00:00:15 +0100
commit01ef7885df38b8ea92c3a0c4cd562ff45bb383c8 (patch)
treedd54053e842c2eb4227a972ef57af2b61aa65878
parent3b1bc6619bf41a9833b2275aed1601631ab30bc4 (diff)
downloadblogc-01ef7885df38b8ea92c3a0c4cd562ff45bb383c8.tar.gz
blogc-01ef7885df38b8ea92c3a0c4cd562ff45bb383c8.tar.bz2
blogc-01ef7885df38b8ea92c3a0c4cd562ff45bb383c8.zip
make: improved runserver docs
-rw-r--r--man/blogc-make.1.ronn7
-rw-r--r--src/blogc-make/main.c3
-rw-r--r--src/blogc-make/rules.c3
3 files changed, 10 insertions, 3 deletions
diff --git a/man/blogc-make.1.ronn b/man/blogc-make.1.ronn
index f60e630..4dc199f 100644
--- a/man/blogc-make.1.ronn
+++ b/man/blogc-make.1.ronn
@@ -42,7 +42,12 @@ See blogcfile(5) for details on the file format.
Clean built files and empty directories in output directory.
* `runserver`:
- Run `blogc-runserver(1)` pointing to output directory, if available.
+ Run `blogc-runserver(1)` pointing to output directory, if available. This
+ rule accepts some arguments, in the following format:
+
+ runserver:host=127.0.0.1,port=8080,threads=20
+
+ The values in the example are the default values.
## BUILD RULES
diff --git a/src/blogc-make/main.c b/src/blogc-make/main.c
index 8c73e13..96a145b 100644
--- a/src/blogc-make/main.c
+++ b/src/blogc-make/main.c
@@ -30,7 +30,8 @@ print_help(void)
"\n"
"positional arguments:\n"
" RULE build rule(s) to run. can include comma-separated\n"
- " key-value pairs of rule settings (default: all)\n"
+ " key-value pairs of rule arguments in the format\n"
+ " RULE:arg1=value1,arg2=value2,... (default: all)\n"
"\n"
"optional arguments:\n"
" -h show this help message and exit\n"
diff --git a/src/blogc-make/rules.c b/src/blogc-make/rules.c
index c0893fa..2633d04 100644
--- a/src/blogc-make/rules.c
+++ b/src/blogc-make/rules.c
@@ -648,7 +648,8 @@ const bm_rule_t rules[] = {
},
{
.name = "runserver",
- .help = "run blogc-runserver pointing to output directory, if available",
+ .help = "run blogc-runserver pointing to output directory, if available\n"
+ " arguments: host (127.0.0.1), port (8080) and threads (20)",
.outputlist_func = NULL,
.exec_func = runserver_exec,
.generate_files = false,