TclTLS
Check-in [15c6ccf987]
Login
HomeTimelineDownloadBrowse SourceBranchesTagsTicketsWiki
Overview
Comment:Updated make documentation to add target for consolidated docs
Downloads: Tarball | ZIP archive | SQL archive
Timelines: family | ancestors | descendants | both | trunk | main
Files: files | file ages | folders
SHA3-256: 15c6ccf987d8f6f23adec514fc5cebc7bc3d28ab28148893d4ff7c38e1a53f0c
User & Date: bohagan on 2024-12-01 02:46:09
Other Links: branch diff | manifest | tags
Context
2024-12-01
23:55
Converted documentation to doctools format and generated HTML and nroff format doc files check-in: 48ff08f855 user: bohagan tags: trunk, main
02:46
Updated make documentation to add target for consolidated docs check-in: 15c6ccf987 user: bohagan tags: trunk, main
2024-11-30
22:00
Added Keywords to documentation check-in: 5963513285 user: bohagan tags: trunk, main
Changes
Unified Diff Ignore Whitespace Patch
Modified Makefile.in from [2fff2bc851] to [3bd105df76].
︙︙
206
207
208
209
210
211
212

213

214





215





216






217



218
219
220
221
222
223
224


#========================================================================
# Your doc target should differentiate from doc builds (by the developer)
# and doc installs (see install-doc), which just install the docs on the
# end user machine when building from source.
#========================================================================


doc:

	@echo "If you have documentation to create, place the commands to"





	@echo "build the docs in the 'doc:' target.  For example:"





	@echo "        xml2nroff sample.xml > sample.n"






	@echo "        xml2html sample.xml > sample.html"




install: all install-binaries install-libraries install-doc-n install-doc-html

install-binaries: binaries install-lib-binaries install-bin-binaries

#========================================================================
# This rule installs platform-independent files, such as header files.








>
|
>
|
>
>
>
>
>
|
>
>
>
>
>
|
>
>
>
>
>
>
|
>
>
>








206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245


#========================================================================
# Your doc target should differentiate from doc builds (by the developer)
# and doc installs (see install-doc), which just install the docs on the
# end user machine when building from source.
#========================================================================

DTPLITE=$(TCLSH) @DTPLITE@

doc: make-docs-n make-docs-html

make-docs-n: doc/tls.man
	@echo "make nroff documentation"
	@if [ -n "$(DTPLITE)" -a -x "$(DTPLITE)" ]; then \
	    $(DTPLITE) -o doc/tls.n nroff doc/tls.man ; \
	fi

make-docs-html: doc/tls.man
	@echo "make HTML documentation"
	@if [ -n "$(DTPLITE)" -a -x "$(DTPLITE)" ]; then \
	    $(DTPLITE) -o doc/tls.html html doc/tls.man ; \
	fi

make-docs: doc/tls.man
	@echo "make documentation"
	@if [ -n "$(DTPLITE)" -a -x "$(DTPLITE)" ]; then \
	    $(DTPLITE) -o doc nroff doc ; \
	    $(DTPLITE) -o doc html doc ; \
	fi

#========================================================================
# Install targets
#========================================================================

install: all install-binaries install-libraries install-doc-n install-doc-html

install-binaries: binaries install-lib-binaries install-bin-binaries

#========================================================================
# This rule installs platform-independent files, such as header files.
︙︙
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258

	done

#========================================================================
# Install documentation.  Unix manpages should go in the $(mandir)
# directory.
#========================================================================

install-doc-html: doc
	@$(INSTALL_DATA_DIR) "$(DESTDIR)$(pkglibdir)/html"
	@echo "Installing HTML documentation in $(DESTDIR)$(pkglibdir)/html"
	@list='doc/*.html'; for i in $$list; do \
	    if test -f $$i ; then \
		echo "Installing $$i"; \
		$(INSTALL_DATA) $$i "$(DESTDIR)$(pkglibdir)/html"; \
	    fi; \
	done

install-doc-n: doc
	@$(INSTALL_DATA_DIR) "$(DESTDIR)$(mandir)/mann"
	@echo "Installing nroff documentation in $(DESTDIR)$(mandir)/mann"
	@list='doc/*.n'; for i in $$list; do \
	    if test -f $$i ; then \
		if test -f "$(DESTDIR)$(mandir)/mann/Tcl.n.gz" -o \
		    "$(DESTDIR)$(mandir)/mann/Tcl*.n.gz" ; then \
		    gzip -k $$i ; \








|









|








255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279

	done

#========================================================================
# Install documentation.  Unix manpages should go in the $(mandir)
# directory.
#========================================================================

install-doc-html: make-docs-html
	@$(INSTALL_DATA_DIR) "$(DESTDIR)$(pkglibdir)/html"
	@echo "Installing HTML documentation in $(DESTDIR)$(pkglibdir)/html"
	@list='doc/*.html'; for i in $$list; do \
	    if test -f $$i ; then \
		echo "Installing $$i"; \
		$(INSTALL_DATA) $$i "$(DESTDIR)$(pkglibdir)/html"; \
	    fi; \
	done

install-doc-n: make-docs-n
	@$(INSTALL_DATA_DIR) "$(DESTDIR)$(mandir)/mann"
	@echo "Installing nroff documentation in $(DESTDIR)$(mandir)/mann"
	@list='doc/*.n'; for i in $$list; do \
	    if test -f $$i ; then \
		if test -f "$(DESTDIR)$(mandir)/mann/Tcl.n.gz" -o \
		    "$(DESTDIR)$(mandir)/mann/Tcl*.n.gz" ; then \
		    gzip -k $$i ; \
︙︙
Modified doc/tls.html from [9a97d7d1b1] to [853fa0c29c].
︙︙
877
878
879
880
881
882
883
884

885
886

887
888
889
890
891
892
893

<p><strong>socket</strong>, <strong>fileevent</strong>, <strong>http</strong>,
<a href="https://www.openssl.org/"><strong>OpenSSL</strong></a></p>

<hr>

<h3><a name="KEYWORDS">KEYWORDS</a></h3>

<p><strong>ssl</strong>, <strong>tls</strong>, <strong>socket</strong>,

<strong>certificate</strong>, <strong>https</strong>


<hr>

<pre>
Copyright &copy; 1999 Matt Newman
Copyright &copy; 2004 Starfish Systems
Copyright &copy; 2023-2024 Brian O'Hagan
</pre>








|
>
|
|
>








877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895

<p><strong>socket</strong>, <strong>fileevent</strong>, <strong>http</strong>,
<a href="https://www.openssl.org/"><strong>OpenSSL</strong></a></p>

<hr>

<h3><a name="KEYWORDS">KEYWORDS</a></h3>

<p><strong>tls</strong>, <strong>I/O</strong>, <strong>IP Address</strong>, <strong>OpenSSL</strong>
<strong>SSL</strong>, <strong>TCP</strong>, <strong>TLS</strong>, <strong>asynchronous I/O</strong>,
<strong>bind</strong>, <strong>certificate</strong>, <strong>channel</strong>, <strong>connection</strong>, 
<strong>domain name</strong>, <strong>host</strong>,<strong>https</strong>, <strong>network address</strong>,
<strong>network</strong>, <strong>socket</strong>, <strong>TclTLS</strong>
<hr>

<pre>
Copyright &copy; 1999 Matt Newman
Copyright &copy; 2004 Starfish Systems
Copyright &copy; 2023-2024 Brian O'Hagan
</pre>
︙︙
Modified win/makefile.vc from [7c67a5e877] to [e472650e39].
︙︙
60
61
62
63
64
65
66




















67
68
69
70
71
72
73

!include "targets.vc"

.SUFFIXES: .c .obj .res .man

#---------------------------------------------------------------------
# Project specific targets
#---------------------------------------------------------------------





















all: setup default-target

clean: default-clean

realclean: default-hose









>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>








60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93

!include "targets.vc"

.SUFFIXES: .c .obj .res .man

#---------------------------------------------------------------------
# Project specific targets
#---------------------------------------------------------------------

# Implicit rule to generate html from man files
# NOTE: this requires doctools from tcllib hence it is not intended
# to be run during install. Rather, use it to generate a new version
# of HTML docs to be stored in the repository.
make-docs-html:
	"$(_INSTALLDIR)\..\bin\tclsh.exe" "$(_INSTALLDIR)\..\bin\dtplite.tcl" \
	    -o "$(ROOT)\doc\$(PROJECT).html" html "$(ROOT)\doc\$(PROJECT).man"

make-docs-n:
	"$(_INSTALLDIR)\..\bin\tclsh.exe" "$(_INSTALLDIR)\..\bin\dtplite.tcl" \
	    -o "$(ROOT)\doc\$(PROJECT).n" nroff "$(ROOT)\doc\$(PROJECT).man"

make-docs:
	"$(_INSTALLDIR)\..\bin\tclsh.exe" "$(_INSTALLDIR)\..\bin\dtplite.tcl" \
	    -o "$DOCDIR" html "$(ROOT)\doc"
	"$(_INSTALLDIR)\..\bin\tclsh.exe" "$(_INSTALLDIR)\..\bin\dtplite.tcl" \
	    -o "$DOCDIR" nroff "$(ROOT)\doc"

docs: make-docs-n make-docs-html 

all: setup default-target

clean: default-clean

realclean: default-hose
︙︙
Powered by Fossil · RSS