diff --git a/Makefile.osx b/Makefile.osx index 44260e84..31384cd4 100644 --- a/Makefile.osx +++ b/Makefile.osx @@ -34,7 +34,7 @@ package: build install -m 644 resources/itworks.html $(OSXBIN_DIR)/index.html install -m 644 resources/civetweb_64x64.png $(OSXBIN_DIR)/ install -m 755 $(CPROG) $(OSXBIN_DIR)/$(PACKAGE) - install -m 644 docs/Installing.md $(DMG_DIR)/Installing.txt + install -m 644 doc/Installing.md $(DMG_DIR)/Installing.txt install -m 644 LICENSE.md $(DMG_DIR)/License.txt rm -rf $(ZIPFILENAME) cd $(DMG_DIR) && zip -r ../../$(ZIPFILENAME) . diff --git a/README.md b/README.md index 1dd4205a..a768dc53 100644 --- a/README.md +++ b/README.md @@ -29,12 +29,12 @@ Trouble tickets should be filed on GitHub Quick start documentation -------------------------- -- [docs/APIReference.md](docs/APIReference.md) - Reference of the C programming API -- [docs/Installing.md](docs/Installing.md) - Install Guide (for end users using pre-built binaries) -- [docs/UserManual.md](docs/UserManual.md) - End User Guide -- [docs/Building.md](docs/Building.md) - Building the Server (quick start guide) -- [docs/Embedding.md](docs/Embedding.md) - Embedding (how to add HTTP support to an existing application) -- [docs/OpenSSL.md](docs/OpenSSL.md) - Adding HTTPS (SSL/TLS) support using OpenSSL. +- [doc/APIReference.md](doc/APIReference.md) - Reference of the C programming API +- [doc/Installing.md](doc/Installing.md) - Install Guide (for end users using pre-built binaries) +- [doc/UserManual.md](doc/UserManual.md) - End User Guide +- [doc/Building.md](doc/Building.md) - Building the Server (quick start guide) +- [doc/Embedding.md](doc/Embedding.md) - Embedding (how to add HTTP support to an existing application) +- [doc/OpenSSL.md](doc/OpenSSL.md) - Adding HTTPS (SSL/TLS) support using OpenSSL. - [RELEASE_NOTES.md](RELEASE_NOTES.md) - Release Notes - [LICENSE.md](LICENSE.md) - Copyright License @@ -61,7 +61,7 @@ simplicity by a carefully selected list of features: Support ------- -This project is very easy to install and use. Please read the [documentation](docs/) and have a look at the [examples] (examples/). +This project is very easy to install and use. Please read the [documentation](doc/) and have a look at the [examples] (examples/). Contributions @@ -71,7 +71,7 @@ Contributions are welcome provided all contributions carry the MIT license. DO NOT APPLY fixes copied from Mongoose to this project to prevent GPL tainting. LibHTTP which is a Civetweb fork is based on a 2014 version of Mongoose and they are developed independently. By now the code base differs, so patches cannot be safely transfered in either direction. -Some guidelines can be found in [docs/Contribution.md](docs/Contribution.md). +Some guidelines can be found in [doc/Contribution.md](doc/Contribution.md). ### Authors diff --git a/RELEASE_NOTES.md b/RELEASE_NOTES.md index 0832a6c0..b838622f 100644 --- a/RELEASE_NOTES.md +++ b/RELEASE_NOTES.md @@ -282,7 +282,7 @@ Changes - Added new C++ abstraction class CivetServer - Added thread safety for and fixed websocket defects (Morgan McGuire) - Created PKGBUILD to use Arch distribution (Daniel Oaks) -- Created new documentation on Embeddeding, Building and yaSSL (see docs/). +- Created new documentation on Embeddeding, Building and yaSSL (see doc/). - Updated License file to include all licenses. - Replaced MD5 implementation due to questionable license. + This requires new source file md5.inl diff --git a/docs/APIReference.md b/doc/APIReference.md similarity index 100% rename from docs/APIReference.md rename to doc/APIReference.md diff --git a/docs/Building.md b/doc/Building.md similarity index 100% rename from docs/Building.md rename to doc/Building.md diff --git a/docs/Contribution.md b/doc/Contribution.md similarity index 100% rename from docs/Contribution.md rename to doc/Contribution.md diff --git a/docs/Embedding.md b/doc/Embedding.md similarity index 100% rename from docs/Embedding.md rename to doc/Embedding.md diff --git a/docs/Installing.md b/doc/Installing.md similarity index 100% rename from docs/Installing.md rename to doc/Installing.md diff --git a/docs/OpenSSL.md b/doc/OpenSSL.md similarity index 100% rename from docs/OpenSSL.md rename to doc/OpenSSL.md diff --git a/docs/UserManual.md b/doc/UserManual.md similarity index 100% rename from docs/UserManual.md rename to doc/UserManual.md diff --git a/docs/api/client_cert.md b/doc/api/client_cert.md similarity index 100% rename from docs/api/client_cert.md rename to doc/api/client_cert.md diff --git a/docs/api/httplib_get_builtin_mime_type.md b/doc/api/httplib_get_builtin_mime_type.md similarity index 100% rename from docs/api/httplib_get_builtin_mime_type.md rename to doc/api/httplib_get_builtin_mime_type.md diff --git a/docs/api/mg_callbacks.md b/doc/api/mg_callbacks.md similarity index 100% rename from docs/api/mg_callbacks.md rename to doc/api/mg_callbacks.md diff --git a/docs/api/mg_check_feature.md b/doc/api/mg_check_feature.md similarity index 100% rename from docs/api/mg_check_feature.md rename to doc/api/mg_check_feature.md diff --git a/docs/api/mg_client_options.md b/doc/api/mg_client_options.md similarity index 100% rename from docs/api/mg_client_options.md rename to doc/api/mg_client_options.md diff --git a/docs/api/mg_close_connection.md b/doc/api/mg_close_connection.md similarity index 100% rename from docs/api/mg_close_connection.md rename to doc/api/mg_close_connection.md diff --git a/docs/api/mg_connect_client.md b/doc/api/mg_connect_client.md similarity index 100% rename from docs/api/mg_connect_client.md rename to doc/api/mg_connect_client.md diff --git a/docs/api/mg_connect_client_secure.md b/doc/api/mg_connect_client_secure.md similarity index 100% rename from docs/api/mg_connect_client_secure.md rename to doc/api/mg_connect_client_secure.md diff --git a/docs/api/mg_connect_websocket_client.md b/doc/api/mg_connect_websocket_client.md similarity index 100% rename from docs/api/mg_connect_websocket_client.md rename to doc/api/mg_connect_websocket_client.md diff --git a/docs/api/mg_cry.md b/doc/api/mg_cry.md similarity index 100% rename from docs/api/mg_cry.md rename to doc/api/mg_cry.md diff --git a/docs/api/mg_download.md b/doc/api/mg_download.md similarity index 100% rename from docs/api/mg_download.md rename to doc/api/mg_download.md diff --git a/docs/api/mg_form_data_handler.md b/doc/api/mg_form_data_handler.md similarity index 100% rename from docs/api/mg_form_data_handler.md rename to doc/api/mg_form_data_handler.md diff --git a/docs/api/mg_get_context.md b/doc/api/mg_get_context.md similarity index 100% rename from docs/api/mg_get_context.md rename to doc/api/mg_get_context.md diff --git a/docs/api/mg_get_cookie.md b/doc/api/mg_get_cookie.md similarity index 100% rename from docs/api/mg_get_cookie.md rename to doc/api/mg_get_cookie.md diff --git a/docs/api/mg_get_header.md b/doc/api/mg_get_header.md similarity index 100% rename from docs/api/mg_get_header.md rename to doc/api/mg_get_header.md diff --git a/docs/api/mg_get_option.md b/doc/api/mg_get_option.md similarity index 100% rename from docs/api/mg_get_option.md rename to doc/api/mg_get_option.md diff --git a/docs/api/mg_get_request_info.md b/doc/api/mg_get_request_info.md similarity index 100% rename from docs/api/mg_get_request_info.md rename to doc/api/mg_get_request_info.md diff --git a/docs/api/mg_get_response.md b/doc/api/mg_get_response.md similarity index 100% rename from docs/api/mg_get_response.md rename to doc/api/mg_get_response.md diff --git a/docs/api/mg_get_response_code_text.md b/doc/api/mg_get_response_code_text.md similarity index 100% rename from docs/api/mg_get_response_code_text.md rename to doc/api/mg_get_response_code_text.md diff --git a/docs/api/mg_get_server_ports.md b/doc/api/mg_get_server_ports.md similarity index 100% rename from docs/api/mg_get_server_ports.md rename to doc/api/mg_get_server_ports.md diff --git a/docs/api/mg_get_user_connection_data.md b/doc/api/mg_get_user_connection_data.md similarity index 100% rename from docs/api/mg_get_user_connection_data.md rename to doc/api/mg_get_user_connection_data.md diff --git a/docs/api/mg_get_user_data.md b/doc/api/mg_get_user_data.md similarity index 100% rename from docs/api/mg_get_user_data.md rename to doc/api/mg_get_user_data.md diff --git a/docs/api/mg_get_valid_options.md b/doc/api/mg_get_valid_options.md similarity index 100% rename from docs/api/mg_get_valid_options.md rename to doc/api/mg_get_valid_options.md diff --git a/docs/api/mg_get_var.md b/doc/api/mg_get_var.md similarity index 100% rename from docs/api/mg_get_var.md rename to doc/api/mg_get_var.md diff --git a/docs/api/mg_get_var2.md b/doc/api/mg_get_var2.md similarity index 100% rename from docs/api/mg_get_var2.md rename to doc/api/mg_get_var2.md diff --git a/docs/api/mg_handle_form_request.md b/doc/api/mg_handle_form_request.md similarity index 100% rename from docs/api/mg_handle_form_request.md rename to doc/api/mg_handle_form_request.md diff --git a/docs/api/mg_header.md b/doc/api/mg_header.md similarity index 100% rename from docs/api/mg_header.md rename to doc/api/mg_header.md diff --git a/docs/api/mg_lock_connection.md b/doc/api/mg_lock_connection.md similarity index 100% rename from docs/api/mg_lock_connection.md rename to doc/api/mg_lock_connection.md diff --git a/docs/api/mg_lock_context.md b/doc/api/mg_lock_context.md similarity index 100% rename from docs/api/mg_lock_context.md rename to doc/api/mg_lock_context.md diff --git a/docs/api/mg_md5.md b/doc/api/mg_md5.md similarity index 100% rename from docs/api/mg_md5.md rename to doc/api/mg_md5.md diff --git a/docs/api/mg_modify_passwords_file.md b/doc/api/mg_modify_passwords_file.md similarity index 100% rename from docs/api/mg_modify_passwords_file.md rename to doc/api/mg_modify_passwords_file.md diff --git a/docs/api/mg_option.md b/doc/api/mg_option.md similarity index 100% rename from docs/api/mg_option.md rename to doc/api/mg_option.md diff --git a/docs/api/mg_printf.md b/doc/api/mg_printf.md similarity index 100% rename from docs/api/mg_printf.md rename to doc/api/mg_printf.md diff --git a/docs/api/mg_read.md b/doc/api/mg_read.md similarity index 100% rename from docs/api/mg_read.md rename to doc/api/mg_read.md diff --git a/docs/api/mg_request_info.md b/doc/api/mg_request_info.md similarity index 100% rename from docs/api/mg_request_info.md rename to doc/api/mg_request_info.md diff --git a/docs/api/mg_send_file.md b/doc/api/mg_send_file.md similarity index 100% rename from docs/api/mg_send_file.md rename to doc/api/mg_send_file.md diff --git a/docs/api/mg_send_mime_file.md b/doc/api/mg_send_mime_file.md similarity index 100% rename from docs/api/mg_send_mime_file.md rename to doc/api/mg_send_mime_file.md diff --git a/docs/api/mg_send_mime_file2.md b/doc/api/mg_send_mime_file2.md similarity index 100% rename from docs/api/mg_send_mime_file2.md rename to doc/api/mg_send_mime_file2.md diff --git a/docs/api/mg_server_ports.md b/doc/api/mg_server_ports.md similarity index 100% rename from docs/api/mg_server_ports.md rename to doc/api/mg_server_ports.md diff --git a/docs/api/mg_set_auth_handler.md b/doc/api/mg_set_auth_handler.md similarity index 100% rename from docs/api/mg_set_auth_handler.md rename to doc/api/mg_set_auth_handler.md diff --git a/docs/api/mg_set_request_handler.md b/doc/api/mg_set_request_handler.md similarity index 100% rename from docs/api/mg_set_request_handler.md rename to doc/api/mg_set_request_handler.md diff --git a/docs/api/mg_set_user_connection_data.md b/doc/api/mg_set_user_connection_data.md similarity index 100% rename from docs/api/mg_set_user_connection_data.md rename to doc/api/mg_set_user_connection_data.md diff --git a/docs/api/mg_set_websocket_handler.md b/doc/api/mg_set_websocket_handler.md similarity index 100% rename from docs/api/mg_set_websocket_handler.md rename to doc/api/mg_set_websocket_handler.md diff --git a/docs/api/mg_start.md b/doc/api/mg_start.md similarity index 100% rename from docs/api/mg_start.md rename to doc/api/mg_start.md diff --git a/docs/api/mg_start_thread.md b/doc/api/mg_start_thread.md similarity index 100% rename from docs/api/mg_start_thread.md rename to doc/api/mg_start_thread.md diff --git a/docs/api/mg_stop.md b/doc/api/mg_stop.md similarity index 100% rename from docs/api/mg_stop.md rename to doc/api/mg_stop.md diff --git a/docs/api/mg_store_body.md b/doc/api/mg_store_body.md similarity index 100% rename from docs/api/mg_store_body.md rename to doc/api/mg_store_body.md diff --git a/docs/api/mg_strcasecmp.md b/doc/api/mg_strcasecmp.md similarity index 100% rename from docs/api/mg_strcasecmp.md rename to doc/api/mg_strcasecmp.md diff --git a/docs/api/mg_strncasecmp.md b/doc/api/mg_strncasecmp.md similarity index 100% rename from docs/api/mg_strncasecmp.md rename to doc/api/mg_strncasecmp.md diff --git a/docs/api/mg_unlock_connection.md b/doc/api/mg_unlock_connection.md similarity index 100% rename from docs/api/mg_unlock_connection.md rename to doc/api/mg_unlock_connection.md diff --git a/docs/api/mg_unlock_context.md b/doc/api/mg_unlock_context.md similarity index 100% rename from docs/api/mg_unlock_context.md rename to doc/api/mg_unlock_context.md diff --git a/docs/api/mg_url_decode.md b/doc/api/mg_url_decode.md similarity index 100% rename from docs/api/mg_url_decode.md rename to doc/api/mg_url_decode.md diff --git a/docs/api/mg_url_encode.md b/doc/api/mg_url_encode.md similarity index 100% rename from docs/api/mg_url_encode.md rename to doc/api/mg_url_encode.md diff --git a/docs/api/mg_version.md b/doc/api/mg_version.md similarity index 100% rename from docs/api/mg_version.md rename to doc/api/mg_version.md diff --git a/docs/api/mg_websocket_client_write.md b/doc/api/mg_websocket_client_write.md similarity index 100% rename from docs/api/mg_websocket_client_write.md rename to doc/api/mg_websocket_client_write.md diff --git a/docs/api/mg_websocket_write.md b/doc/api/mg_websocket_write.md similarity index 100% rename from docs/api/mg_websocket_write.md rename to doc/api/mg_websocket_write.md diff --git a/docs/api/mg_write.md b/doc/api/mg_write.md similarity index 100% rename from docs/api/mg_write.md rename to doc/api/mg_write.md diff --git a/docs/yaSSL.md b/doc/yaSSL.md similarity index 100% rename from docs/yaSSL.md rename to doc/yaSSL.md diff --git a/src/main.c b/src/main.c index cc22b1dc..b84fa25e 100644 --- a/src/main.c +++ b/src/main.c @@ -255,7 +255,7 @@ static NO_RETURN void show_usage_and_exit(const char *exeName) { static const char *config_file_top_comment = "# LibHTTP web server configuration file.\n" "# For detailed description of every option, visit\n" - "# https://github.com/lammertb/libhttp/blob/master/docs/UserManual.md\n" + "# https://github.com/lammertb/libhttp/blob/master/doc/UserManual.md\n" "# Lines starting with '#' and empty lines are ignored.\n" "# To make a change, remove leading '#', modify option's value,\n" "# save this file and then restart LibHTTP.\n\n";