From mboxrd@z Thu Jan 1 00:00:00 1970 Authentication-Results: mail-a.sr.ht; dkim=pass header.d=maniero.me header.i=@maniero.me Received: from sienna.cherry.relay.mailchannels.net (sienna.cherry.relay.mailchannels.net [23.83.223.165]) by mail-a.sr.ht (Postfix) with ESMTPS id 5569020098 for <~johnnyrichard/olang-devel@lists.sr.ht>; Mon, 19 Feb 2024 20:42:16 +0000 (UTC) X-Sender-Id: hostingeremail|x-authuser|carlos@maniero.me Received: from relay.mailchannels.net (localhost [127.0.0.1]) by relay.mailchannels.net (Postfix) with ESMTP id B8F608413D2 for <~johnnyrichard/olang-devel@lists.sr.ht>; Mon, 19 Feb 2024 20:42:14 +0000 (UTC) Received: from nl-srv-smtpout4.hostinger.io (unknown [127.0.0.6]) (Authenticated sender: hostingeremail) by relay.mailchannels.net (Postfix) with ESMTPA id 213968440DE for <~johnnyrichard/olang-devel@lists.sr.ht>; Mon, 19 Feb 2024 20:42:13 +0000 (UTC) ARC-Seal: i=1; s=arc-2022; d=mailchannels.net; t=1708375334; a=rsa-sha256; cv=none; b=aQWQcSoTiwZn/q0IDYdVWzcJf5+kagnxYJwAgys6cgy0hiI/7n9AHRZIE/xKHl6BlzC++j dpzbECHAMkvv+C4jGOGcQmXCAF6yXeTwgylhjF2g4DbX3qt/C7ro6O2bhaWAeBI58AqknK L+v3pNq/zMLuooHW5G9THmmQYwngczOmNGBdcMyg+vItZDVzPHGG/EWx+OO6UrKh82WQ31 JsfiQIRJyh3kAM114zLzz42+vtSJ5hjLjVO9u1SguY2pGJA6jY/zCWwFHKDVzX+7n5E8dP woJGHj/iuj67FRXy+9BKPPZAOcsxQ0dvxrqB9YJaOooA1lMsSWT+RN1+KcxVhw== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=mailchannels.net; s=arc-2022; t=1708375334; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:cc:mime-version:mime-version: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references:dkim-signature; bh=CMKXm3UpFd+AudDb+Tu4Wkfzg9F3jyqkE1tRUfS7CoU=; b=DLk7Urzde1piyQlhWZb3IHXUKVteAGLDcYACzDJqnhf9jQ+k3TrwkCA+94VefnSyHuwKJA pprF7jCs8znnF/IUBvtElW6XghACMUnk9A94RHpqQ1jqlloi568+ZCooU20s/iAQF3d5q8 NWl0EWOSvQjf5mwi/yjkTZEUqU0EdnsjoXyJxOaHG1bPUZDY0kfIWvTqAhBCMg3IOy8iN+ 8X1SrRc+HGRyBlCAYyzQLymSwaPyc3YN50Ftlz/zl2vSjE9A/TpqqA8UrT9eHaW3FHZuCj naHZhq2/VAK7eqqsgcPnCGY7canQMrZUhpMqof0eORbZpcWT+HG0aG4fX5O2Ag== ARC-Authentication-Results: i=1; rspamd-6bdc45795d-27scv; auth=pass smtp.auth=hostingeremail smtp.mailfrom=carlos@maniero.me X-Sender-Id: hostingeremail|x-authuser|carlos@maniero.me X-MC-Relay: Neutral X-MailChannels-SenderId: hostingeremail|x-authuser|carlos@maniero.me X-MailChannels-Auth-Id: hostingeremail X-Spill-Ski: 4672bc74251f10ab_1708375334636_608127532 X-MC-Loop-Signature: 1708375334636:1639860707 X-MC-Ingress-Time: 1708375334636 Received: from nl-srv-smtpout4.hostinger.io (nl-srv-smtpout4.hostinger.io [145.14.159.45]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384) by 100.119.153.87 (trex/6.9.2); Mon, 19 Feb 2024 20:42:14 +0000 From: Carlos Maniero DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=maniero.me; s=hostingermail1; t=1708375332; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:cc:mime-version:mime-version: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references; bh=CMKXm3UpFd+AudDb+Tu4Wkfzg9F3jyqkE1tRUfS7CoU=; b=wPZUR0z/8QYuKhltge1wxbYslTc5zEDRsiP3OCVbroIdwpPzSdyBr4exjPoGYHeifITUle wmRz90e3y4+KwnNbmmDEUTW4wiLRNsnRN2qHH83vw2uYuU0I0wEnNfO+pMTCBPCSOW63he ppX2qO0BmJKs6m+uPtANWiBr8EzupA8nPW49b+In4t4FKwFBmQl7b6WL9+gyqza2hX1WgR r2rTpF/PqjmvBkihX/pKHx/+e/zRaI3LbiCLL6BN8btt6h92VoQoqJZpiiF64zmNQxJkuT mtcT5Ogx7iFkAYUb15CpnwkGmEEzoEzEvwbztuEaJWLB8G+QmH08N7DitFuIAQ== To: ~johnnyrichard/olang-devel@lists.sr.ht Cc: Johnny Richard Subject: [PATCH olang v5 3/4] docs: create man page for 0c compiler Date: Mon, 19 Feb 2024 17:37:29 -0300 Message-Id: <20240219203729.1637937-1-carlos@maniero.me> X-Mailer: git-send-email 2.34.1 In-Reply-To: <20240219211240.25871-1-johnny@johnnyrichard.com> References: <20240219211240.25871-1-johnny@johnnyrichard.com> MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-CM-Envelope: MS4xfKUxTgthNE9zb1LsEe8AAvJhfIJAOWOSrateeayWRkq/mAWmwNdiX7Htl5u7STOz5JnyyVzKrjyDFKuA0ANv0aDqaeIEXUnQqjU46MjwjGFS+IJ9Cqow ubE+i95rpNNFn4F1l/pzeCul85WGMQymnDPdDXohct9qrxijX8d7QmxVtyxZ1xF2Ku+jQ/6wJddHmJnYuUnN8wPR/dGQyqcFKA5ewtDGZtSm0/1WxHi/7m2I l+vFaxZwQ8Gb9EKKhEJEOw== X-CM-Analysis: v=2.4 cv=DIOJ4TNb c=1 sm=1 tr=0 ts=65d3bd24 a=5+VMC1FZ3J4mVPAKpPmAqg==:117 a=5+VMC1FZ3J4mVPAKpPmAqg==:17 a=MKtGQD3n3ToA:10 a=1oJP67jkp3AA:10 a=BXDaF_L80NYA:10 a=jziKOLAnAAAA:8 a=DW6YCl59L6fPoImnRmUA:9 a=1ljl-wuu_96014yfT5Vk:22 X-AuthUser: carlos@maniero.me X-TUID: 0zZcMu2G0cJk From: Johnny Richard Since the 0c compiler contains a --dump-tokens functionality, it has been documented as well. The site build has been adapted to accommodate the manpages build. Everything should work as before for site generation. Signed-off-by: Johnny Richard --- docs/Makefile | 21 +++++++++++++++------ docs/manpages/0c.md | 21 +++++++++++++++++++++ src/0c.c | 1 - 3 files changed, 36 insertions(+), 7 deletions(-) create mode 100644 docs/manpages/0c.md diff --git a/docs/Makefile b/docs/Makefile index 731da5d..54561a1 100644 --- a/docs/Makefile +++ b/docs/Makefile @@ -1,14 +1,16 @@ PANDOC := pandoc INDEX := index.md BUILD_DIR := build -TARGET := $(BUILD_DIR)/index.html +SITE_DIR := $(BUILD_DIR)/site +TARGET := $(SITE_DIR)/index.html DIST_FILE := site.tar.gz PAGES_DIR := pages +MANPAGES := $(BUILD_DIR)/man PAGES := $(wildcard $(PAGES_DIR)/*.md) -HTML_PAGES := $(patsubst $(PAGES_DIR)/%.md, $(BUILD_DIR)/$(PAGES_DIR)/%.html, $(PAGES)) +HTML_PAGES := $(patsubst $(PAGES_DIR)/%.md, $(SITE_DIR)/$(PAGES_DIR)/%.html, $(PAGES)) .PHONY: all -all: $(BUILD_DIR) $(TARGET) $(PAGES) +all: $(BUILD_DIR) $(TARGET) $(PAGES) manpages .PHONY: clean clean: @@ -18,15 +20,22 @@ clean: .PHONY: dist dist: $(DIST_FILE) +.PHONY: manpages +manpages: $(BUILD_DIR) $(MANPAGES)/0c.1 + +$(MANPAGES)/%.1: manpages/%.md + $(PANDOC) -s -t man $< > $@ + $(DIST_FILE): all - tar -czf $(DIST_FILE) -C $(BUILD_DIR) . + tar -czf $(DIST_FILE) -C $(SITE_DIR) . $(TARGET): $(HTML_PAGES) $(PANDOC) -s --template template.html -f markdown -t html $(INDEX) > $(TARGET) $(BUILD_DIR): @mkdir -p $@ - @mkdir -p $@/$(PAGES_DIR) + @mkdir -p $(SITE_DIR)/$(PAGES_DIR) + @mkdir -p $(MANPAGES) -$(BUILD_DIR)/$(PAGES_DIR)/%.html: $(PAGES_DIR)/%.md +$(SITE_DIR)/$(PAGES_DIR)/%.html: $(PAGES_DIR)/%.md $(PANDOC) -s --template template.html -f markdown -t html --toc $< > $@ diff --git a/docs/manpages/0c.md b/docs/manpages/0c.md new file mode 100644 index 0000000..87a56df --- /dev/null +++ b/docs/manpages/0c.md @@ -0,0 +1,21 @@ +% 0C(1) +% olang mantainers +% Feb 2024 + +# NAME + +0c - zero langague compiler + +# SYNOPSIS + +**0c** **----dump-tokens** source.0 + +# DESCRIPTION + +**0c** is the offical compiler for zero language, it is also a tool that +contains utilities to help the language development. + +# GENERAL OPTIONS + +**----dump-tokens** +: Display lexical tokens given a soruce.0 code. diff --git a/src/0c.c b/src/0c.c index 0af9caa..e84559d 100644 --- a/src/0c.c +++ b/src/0c.c @@ -34,7 +34,6 @@ cli_args_shift(cli_args_t *args); typedef struct cli_opts { - // TODO: create man page instruction for --dump-tokens option bool dump_tokens; char *file_path; } cli_opts_t; -- 2.43.2