aboutsummaryrefslogtreecommitdiff
path: root/guide/faq.md
diff options
context:
space:
mode:
authorruki <waruqi@gmail.com>2019-06-22 00:51:03 +0800
committerruki <waruqi@gmail.com>2019-06-21 23:06:22 +0800
commiteb349bcce1c18b3823194c62c532c1ca96503a4f (patch)
tree0b6ee9c8aefbb2ea9a9a690d337950de439a9192 /guide/faq.md
parentfbe5b23eeca6c2a15958e655e79de2368f00220d (diff)
downloadxmake-docs-eb349bcce1c18b3823194c62c532c1ca96503a4f.tar.gz
xmake-docs-eb349bcce1c18b3823194c62c532c1ca96503a4f.zip
add guide and plugin
Diffstat (limited to 'guide/faq.md')
-rw-r--r--guide/faq.md86
1 files changed, 86 insertions, 0 deletions
diff --git a/guide/faq.md b/guide/faq.md
new file mode 100644
index 00000000..0afdabfe
--- /dev/null
+++ b/guide/faq.md
@@ -0,0 +1,86 @@
+
+## How to get verbose command-line arguments info?
+
+Get the help info of the main command.
+
+```bash
+$ xmake [-h|--help]
+```
+
+Get the help info of the configuration command.
+
+```bash
+$ xmake f [-h|--help]
+```
+
+Get the help info of the givent action or plugin command.
+
+```bash
+$ xmake [action|plugin] [-h|--help]
+```
+
+For example:
+
+```bash
+$ xmake run --help
+```
+
+## How to suppress all output info?
+
+```bash
+$ xmake [-q|--quiet]
+```
+
+## How to do if xmake fails?
+
+Please attempt to clean configuration and rebuild it first.
+
+```bash
+$ xmake f -c
+$ xmake
+```
+
+If it fails again, please add `-v` or `--verbose` options to get more verbose info.
+
+For exmaple:
+
+```hash
+$ xmake [-v|--verbose]
+```
+
+And add `--backtrace` to get the verbose backtrace info, then you can submit these infos to [issues](https://github.com/xmake-io/xmake/issues).
+
+```bash
+$ xmake -v --backtrace
+```
+
+## How to see verbose compiling warnings?
+
+```bash
+$ xmake [-w|--warning]
+```
+
+## How to scan source code and generate xmake.lua automaticlly
+
+You only need run the following command:
+
+```bash
+$ xmake
+```
+
+xmake will scan all source code in current directory and build it automaticlly.
+
+And we can run it directly.
+
+```bash
+$ xmake run
+```
+
+If we only want to generate xmake.lua file, we can run:
+
+```bash
+$ xmake f -y
+```
+
+If you want to known more information please see [Scan source codes and build project without makefile](https://tboox.org/2017/01/07/build-without-makefile/)
+