Skip to content

Commit

Permalink
cleanup; move ./etc into ./samples and mark 'unsupported'
Browse files Browse the repository at this point in the history
  • Loading branch information
Tieske committed Mar 29, 2022
1 parent 7187be8 commit 86de838
Show file tree
Hide file tree
Showing 18 changed files with 98 additions and 112 deletions.
2 changes: 0 additions & 2 deletions .luacheckrc
Original file line number Diff line number Diff line change
Expand Up @@ -15,8 +15,6 @@ include_files = {
}

exclude_files = {
"etc/*.lua",
"etc/**/*.lua",
"test/*.lua",
"test/**/*.lua",
"samples/*.lua",
Expand Down
89 changes: 0 additions & 89 deletions etc/README

This file was deleted.

1 change: 0 additions & 1 deletion luasocket-scm-3.rockspec
Original file line number Diff line number Diff line change
Expand Up @@ -129,6 +129,5 @@ build = {
copy_directories = {
"docs"
, "samples"
, "etc"
, "test" }
}
28 changes: 11 additions & 17 deletions makefile.dist
Original file line number Diff line number Diff line change
Expand Up @@ -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 \
Expand Down Expand Up @@ -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

Expand Down
90 changes: 87 additions & 3 deletions samples/README
Original file line number Diff line number Diff line change
@@ -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 <remote-file> [<local-file>]

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] {<url>} > 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'

Expand All @@ -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 <filename>
samples directory. Just run 'lua lpr.lua <filename>
queue=<printername>' 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

Expand Down
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.

0 comments on commit 86de838

Please sign in to comment.