From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mp1.migadu.com ([2001:41d0:403:58f0::]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits)) by ms5.migadu.com with LMTPS id oKUyMk1e6WaZQAAA62LTzQ:P1 (envelope-from ) for ; Tue, 17 Sep 2024 12:47:41 +0200 Received: from aspmx1.migadu.com ([2001:41d0:403:58f0::]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits)) by mp1.migadu.com with LMTPS id oKUyMk1e6WaZQAAA62LTzQ (envelope-from ) for ; Tue, 17 Sep 2024 12:47:41 +0200 X-Envelope-To: patches@johnnyrichard.com Authentication-Results: aspmx1.migadu.com; none Received: from mail-a.sr.ht (mail-a.sr.ht [46.23.81.152]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (2048 bits) server-digest SHA256) (No client certificate requested) by aspmx1.migadu.com (Postfix) with ESMTPS id BC3617FD9B for ; Tue, 17 Sep 2024 12:47:41 +0200 (CEST) DKIM-Signature: a=rsa-sha256; bh=7xD04uIuW9CeWbRwOyH7P0pj+8Y64k+qJjg8lU8yAag=; c=simple/simple; d=lists.sr.ht; h=From:To:Cc:Subject:Date:In-Reply-To:References:List-Unsubscribe:List-Subscribe:List-Archive:List-Post:List-ID; q=dns/txt; s=20240113; t=1726570061; v=1; b=afpjW4X9a6ICC5ZMWbnAtYtF5qd0BJwHGBm5Z9FrX6Jn6A5gCiEYZQqOIyjLZu8xAnhc2CDP gR2/nAO2BaSgFoAY/xVAJkyoZx4WXfEmjvrrIeHWsnYRwVMzliNcO6tLf9EXRI89CjU3KcVTNNn yPC4Upda7c1IB10Vu7jLQc+LV6GDC7Um+kEorF1lUiVYPjINpzTMEkextlLMwA1xCOktjXtwxby jpzhAhUETHe0Zenb8XgOC+pcyRFKxaPGcWzHylYgWNMvhQ1sxComiagI6+i35KIEuVe6WCFFzJU ssHjlrxfWVNb4xKJMryEIYZFhSOo4igClw33RysbkV6hQ== Received: from lists.sr.ht (unknown [46.23.81.154]) by mail-a.sr.ht (Postfix) with ESMTPSA id 8E0EE20234 for ; Tue, 17 Sep 2024 10:47:41 +0000 (UTC) Received: from out-171.mta1.migadu.com (out-171.mta1.migadu.com [95.215.58.171]) by mail-a.sr.ht (Postfix) with ESMTPS id BAD9620237 for <~johnnyrichard/olang-devel@lists.sr.ht>; Tue, 17 Sep 2024 10:47:40 +0000 (UTC) X-Report-Abuse: Please report any abuse attempt to abuse@migadu.com and include these headers. DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=johnnyrichard.com; s=key1; t=1726570060; 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=cqnG9Wb1yx9Hv1XyzxSxMKJ+TNXy4NBach3Mu9I9KFA=; b=YYPF6e7WcHi71TXs3c30Ehj9+DOwwXLtXXYjjuiAZmF6QFGRpEpPAtFCDvP8V8Ppx9sBQS nN/1h/ift4/Onx8XRGdTDnbsFxKNqu4gtoLY0+o/P2QzbKILXAx0MR4Fji365nCsqaqGwk tcvhwd43qp2Mi7l2x4nD51hpld/DyOBX1djMEhkIRG0w7s0EvcdVuXuG4514hiRUvewQTI SITD4dpjXIa2CGg3wVH54yecToR8eI1/MpWWuPrg75d4IpzGxR1vq0vv0eOX9lVgeqwHDo FI7lH/rTQMlPc3bL0z+ULZTMLSwUTE2DsJHno7docGBBZxaDWUomkRk4LePAJQ== From: Johnny Richard To: ~johnnyrichard/olang-devel@lists.sr.ht Cc: Johnny Richard Subject: [PATCH olang v1 4/4] docs: info: add instructions to install/uninstall olang Date: Tue, 17 Sep 2024 14:46:18 +0200 Message-ID: <20240917124716.184501-5-johnny@johnnyrichard.com> In-Reply-To: <20240917124716.184501-1-johnny@johnnyrichard.com> References: <20240917124716.184501-1-johnny@johnnyrichard.com> MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Sourcehut-Patchset-Status: PROPOSED List-Unsubscribe: List-Subscribe: List-Archive: Archived-At: List-Post: List-ID: ~johnnyrichard/olang-devel <~johnnyrichard/olang-devel.lists.sr.ht> Sender: ~johnnyrichard/olang-devel <~johnnyrichard/olang-devel@lists.sr.ht> X-Migadu-Flow: FLOW_IN X-Migadu-Country: NL X-Migadu-Queue-Id: BC3617FD9B X-Migadu-Scanner: mx11.migadu.com X-Spam-Score: -4.00 X-Migadu-Spam-Score: -4.00 X-TUID: KORWgWulgXJS Signed-off-by: Johnny Richard --- docs/info/installation.texi | 78 +++++++++++++++++++++++++++++++++++++ 1 file changed, 78 insertions(+) diff --git a/docs/info/installation.texi b/docs/info/installation.texi index ef79184..d61b0e9 100644 --- a/docs/info/installation.texi +++ b/docs/info/installation.texi @@ -1,2 +1,80 @@ @node Installation @chapter Installation + +This installation assumes you are running an unix like operation system and +requires @code{make}, @code{makeinfo} and a @strong{c compiler} installed. + +The following commands will compile the the code and install @code{olang} +binary, @code{man} pages and @code{info} docs into your system. + +@verbatim +$ make +$ make install +@end verbatim + +And for uninstall the program run + +@verbatim +$ make uninstall +@end verbatim + +@section Custom Installation + +There are few @code{make} variables which can be used to customize your +installation as described bellow. + +@table @samp + +@item PREFIX + +The prefix where the compiler and docs should be installed, it is set to +@code{/usr/local} if not specified. + +@item BINDIR + +The path where the compiler binary will be installed, it is set to +@code{$PREFIX/bin} if not specified. + +@item DATADIR + +The path where the read-only documents will be installed, it is set to +@code{$PREFIX/share} if not specified. + +@item MANDIR + +The path where the man documents will be installed, it is set to +@code{$DATADIR/man} if not specified. + +@item MAN1DIR + +The path where the man1 documents will be installed, it is set to +@code{$MANDIR/man1} if not specified. + +@item INFODIR + +The path where the info documents will be installed, it is set to +@code{$DATADIR/info} if not specified. + +@item DESTDIR + +In case you are installing the compiler on different root than @code{/} (by +default the install assumes the destination dir as root), you can set the +variable @strong{DESTDIR} on @code{make} for example: + +@verbatim +$ make DESTDIR=/mnt/linux-root install +@end verbatim + +@end table + +@section Developer Tips + +If you want to install the compiler but do not want to make it system +available, you might want to have it installed on the @code{XDG} +@strong{~/.local} directory. Make sure you have set @code{PATH}, +@code{MANPATH} and @code{INFOPATH} correctly so you can have the resources +installed available on your shell. + +@verbatim +$ make PREFIX=~/.local install +@end verbatim -- 2.46.0