From 86de838eb5ed49711be8d62e01255cc2ccd3342e Mon Sep 17 00:00:00 2001 From: Thijs Schreijer Date: Wed, 23 Mar 2022 16:05:11 +0100 Subject: [PATCH] cleanup; move ./etc into ./samples and mark 'unsupported' --- .luacheckrc | 2 - etc/README | 89 ------------------------------ luasocket-scm-3.rockspec | 1 - makefile.dist | 28 ++++------ samples/README | 90 +++++++++++++++++++++++++++++-- {etc => samples}/b64.lua | 0 {etc => samples}/check-links.lua | 0 {etc => samples}/check-memory.lua | 0 {etc => samples}/cookie.lua | 0 {etc => samples}/dict.lua | 0 {etc => samples}/dispatch.lua | 0 {etc => samples}/eol.lua | 0 {etc => samples}/forward.lua | 0 {etc => samples}/get.lua | 0 {etc => samples}/links | 0 {etc => samples}/lp.lua | 0 {etc => samples}/qp.lua | 0 {etc => samples}/tftp.lua | 0 18 files changed, 98 insertions(+), 112 deletions(-) delete mode 100644 etc/README rename {etc => samples}/b64.lua (100%) rename {etc => samples}/check-links.lua (100%) rename {etc => samples}/check-memory.lua (100%) rename {etc => samples}/cookie.lua (100%) rename {etc => samples}/dict.lua (100%) rename {etc => samples}/dispatch.lua (100%) rename {etc => samples}/eol.lua (100%) rename {etc => samples}/forward.lua (100%) rename {etc => samples}/get.lua (100%) rename {etc => samples}/links (100%) rename {etc => samples}/lp.lua (100%) rename {etc => samples}/qp.lua (100%) rename {etc => samples}/tftp.lua (100%) diff --git a/.luacheckrc b/.luacheckrc index 8b25dd7..a3b4f63 100644 --- a/.luacheckrc +++ b/.luacheckrc @@ -15,8 +15,6 @@ include_files = { } exclude_files = { - "etc/*.lua", - "etc/**/*.lua", "test/*.lua", "test/**/*.lua", "samples/*.lua", diff --git a/etc/README b/etc/README deleted file mode 100644 index cfd3e37..0000000 --- a/etc/README +++ /dev/null @@ -1,89 +0,0 @@ -This directory contains code that is more useful than the -samples. This code *is* supported. - - tftp.lua -- Trivial FTP client - -This module implements file retrieval by the TFTP protocol. -Its main use was to test the UDP code, but since someone -found it usefull, I turned it into a module that is almost -official (no uploads, yet). - - dict.lua -- Dict client - -The dict.lua module started with a cool simple client -for the DICT protocol, written by Luiz Henrique Figueiredo. -This new version has been converted into a library, similar -to the HTTP and FTP libraries, that can be used from within -any luasocket application. Take a look on the source code -and you will be able to figure out how to use it. - - lp.lua -- LPD client library - -The lp.lua module implements the client part of the Line -Printer Daemon protocol, used to print files on Unix -machines. It is courtesy of David Burgess! See the source -code and the lpr.lua in the examples directory. - - b64.lua - qp.lua - eol.lua - -These are tiny programs that perform Base64, -Quoted-Printable and end-of-line marker conversions. - - get.lua -- file retriever - -This little program is a client that uses the FTP and -HTTP code to implement a command line file graber. Just -run - - lua get.lua [] - -to download a remote file (either ftp:// or http://) to -the specified local file. The program also prints the -download throughput, elapsed time, bytes already downloaded -etc during download. - - check-memory.lua -- checks memory consumption - -This is just to see how much memory each module uses. - - dispatch.lua -- coroutine based dispatcher - -This is a first try at a coroutine based non-blocking -dispatcher for LuaSocket. Take a look at 'check-links.lua' -and at 'forward.lua' to see how to use it. - - check-links.lua -- HTML link checker program - -This little program scans a HTML file and checks for broken -links. It is similar to check-links.pl by Jamie Zawinski, -but uses all facilities of the LuaSocket library and the Lua -language. It has not been thoroughly tested, but it should -work. Just run - - lua check-links.lua [-n] {} > output - -and open the result to see a list of broken links. Make sure -you check the '-n' switch. It runs in non-blocking mode, -using coroutines, and is MUCH faster! - - forward.lua -- coroutine based forward server - -This is a forward server that can accept several connections -and transfers simultaneously using non-blocking I/O and the -coroutine-based dispatcher. You can run, for example - - lua forward.lua 8080:proxy.com:3128 - -to redirect all local conections to port 8080 to the host -'proxy.com' at port 3128. - - unix.c and unix.h - -This is an implementation of Unix local domain sockets and -demonstrates how to extend LuaSocket with a new type of -transport. It has been tested on Linux and on Mac OS X. - -Good luck, -Diego. diff --git a/luasocket-scm-3.rockspec b/luasocket-scm-3.rockspec index 71f335c..f3d24e3 100644 --- a/luasocket-scm-3.rockspec +++ b/luasocket-scm-3.rockspec @@ -129,6 +129,5 @@ build = { copy_directories = { "docs" , "samples" - , "etc" , "test" } } diff --git a/makefile.dist b/makefile.dist index a27ba57..5ef44d3 100644 --- a/makefile.dist +++ b/makefile.dist @@ -22,20 +22,17 @@ SAMPLES = \ samples/lpr.lua \ samples/talker.lua \ samples/tinyirc.lua - -ETC = \ - etc/README \ - etc/b64.lua \ - etc/check-links.lua \ - etc/check-memory.lua \ - etc/dict.lua \ - etc/dispatch.lua \ - etc/eol.lua \ - etc/forward.lua \ - etc/get.lua \ - etc/lp.lua \ - etc/qp.lua \ - etc/tftp.lua + samples/b64.lua \ + samples/check-links.lua \ + samples/check-memory.lua \ + samples/dict.lua \ + samples/dispatch.lua \ + samples/eol.lua \ + samples/forward.lua \ + samples/get.lua \ + samples/lp.lua \ + samples/qp.lua \ + samples/tftp.lua SRC = \ src/makefile \ @@ -117,9 +114,6 @@ dist: cp -vf README.md $(DIST) cp -vf $(MAKE) $(DIST) - mkdir -p $(DIST)/etc - cp -vf $(ETC) $(DIST)/etc - mkdir -p $(DIST)/src cp -vf $(SRC) $(DIST)/src diff --git a/samples/README b/samples/README index e63a6f5..4ee06b6 100644 --- a/samples/README +++ b/samples/README @@ -1,11 +1,95 @@ This directory contains some sample programs using LuaSocket. This code is not supported. + tftp.lua -- Trivial FTP client + +This module implements file retrieval by the TFTP protocol. +Its main use was to test the UDP code, but since someone +found it usefull, I turned it into a module that is almost +official (no uploads, yet). + + dict.lua -- Dict client + +The dict.lua module started with a cool simple client +for the DICT protocol, written by Luiz Henrique Figueiredo. +This new version has been converted into a library, similar +to the HTTP and FTP libraries, that can be used from within +any luasocket application. Take a look on the source code +and you will be able to figure out how to use it. + + lp.lua -- LPD client library + +The lp.lua module implements the client part of the Line +Printer Daemon protocol, used to print files on Unix +machines. It is courtesy of David Burgess! See the source +code and the lpr.lua in the examples directory. + + b64.lua + qp.lua + eol.lua + +These are tiny programs that perform Base64, +Quoted-Printable and end-of-line marker conversions. + + get.lua -- file retriever + +This little program is a client that uses the FTP and +HTTP code to implement a command line file graber. Just +run + + lua get.lua [] + +to download a remote file (either ftp:// or http://) to +the specified local file. The program also prints the +download throughput, elapsed time, bytes already downloaded +etc during download. + + check-memory.lua -- checks memory consumption + +This is just to see how much memory each module uses. + + dispatch.lua -- coroutine based dispatcher + +This is a first try at a coroutine based non-blocking +dispatcher for LuaSocket. Take a look at 'check-links.lua' +and at 'forward.lua' to see how to use it. + + check-links.lua -- HTML link checker program + +This little program scans a HTML file and checks for broken +links. It is similar to check-links.pl by Jamie Zawinski, +but uses all facilities of the LuaSocket library and the Lua +language. It has not been thoroughly tested, but it should +work. Just run + + lua check-links.lua [-n] {} > output + +and open the result to see a list of broken links. Make sure +you check the '-n' switch. It runs in non-blocking mode, +using coroutines, and is MUCH faster! + + forward.lua -- coroutine based forward server + +This is a forward server that can accept several connections +and transfers simultaneously using non-blocking I/O and the +coroutine-based dispatcher. You can run, for example + + lua forward.lua 8080:proxy.com:3128 + +to redirect all local conections to port 8080 to the host +'proxy.com' at port 3128. + + unix.c and unix.h + +This is an implementation of Unix local domain sockets and +demonstrates how to extend LuaSocket with a new type of +transport. It has been tested on Linux and on Mac OS X. + listener.lua -- socket to stdout talker.lua -- stdin to socket listener.lua and talker.lua are about the simplest -applications you can write using LuaSocket. Run +applications you can write using LuaSocket. Run 'lua listener.lua' and 'lua talker.lua' @@ -17,13 +101,13 @@ be printed by listen.lua. This is a cool program written by David Burgess to print files using the Line Printer Daemon protocol, widely used in Unix machines. It uses the lp.lua implementation, in the -etc directory. Just run 'lua lpr.lua +samples directory. Just run 'lua lpr.lua queue=' and the file will print! cddb.lua -- CDDB client This is the first try on a simple CDDB client. Not really -useful, but one day it might become a module. +useful, but one day it might become a module. daytimeclnt.lua -- day time client diff --git a/etc/b64.lua b/samples/b64.lua similarity index 100% rename from etc/b64.lua rename to samples/b64.lua diff --git a/etc/check-links.lua b/samples/check-links.lua similarity index 100% rename from etc/check-links.lua rename to samples/check-links.lua diff --git a/etc/check-memory.lua b/samples/check-memory.lua similarity index 100% rename from etc/check-memory.lua rename to samples/check-memory.lua diff --git a/etc/cookie.lua b/samples/cookie.lua similarity index 100% rename from etc/cookie.lua rename to samples/cookie.lua diff --git a/etc/dict.lua b/samples/dict.lua similarity index 100% rename from etc/dict.lua rename to samples/dict.lua diff --git a/etc/dispatch.lua b/samples/dispatch.lua similarity index 100% rename from etc/dispatch.lua rename to samples/dispatch.lua diff --git a/etc/eol.lua b/samples/eol.lua similarity index 100% rename from etc/eol.lua rename to samples/eol.lua diff --git a/etc/forward.lua b/samples/forward.lua similarity index 100% rename from etc/forward.lua rename to samples/forward.lua diff --git a/etc/get.lua b/samples/get.lua similarity index 100% rename from etc/get.lua rename to samples/get.lua diff --git a/etc/links b/samples/links similarity index 100% rename from etc/links rename to samples/links diff --git a/etc/lp.lua b/samples/lp.lua similarity index 100% rename from etc/lp.lua rename to samples/lp.lua diff --git a/etc/qp.lua b/samples/qp.lua similarity index 100% rename from etc/qp.lua rename to samples/qp.lua diff --git a/etc/tftp.lua b/samples/tftp.lua similarity index 100% rename from etc/tftp.lua rename to samples/tftp.lua