Welcome to pyfingerd’s documentation!

finger is both a protocol and a utility to get the information and status from a user on a distant machine. It was standardized in RFC 742 in 1977, then in RFC 1288 in 1991, and has been abandoned since.

pyfingerd is an implementation for this protocol, which allows you to:

• Run a finger server using system information on Linux and *BSD systems.

• Run a finger server using a scenario for animating alternate reality games or confusing potential attackers.

• Implement your own finger server in Python using sensible defaults.

For more information, you can consult:

• The project homepage at pyfingerd.touhey.pro.

• The PyPI project page at pypi.org.

• The source at forge.touhey.org.

The documentation contents is the following:

• Onboarding
  • Installing pyfingerd
    • Installing pyfingerd using pip
    • Installing pyfingerd from source
  • Running pyfingerd
    • Setting up your finger client
    • Using a different port
    • Setting the hostname
  • Tweaking pyfingerd
• Guides
  • Writing a scenario for pyfingerd
    • Initializing the environment
    • The set up
    • The main events
    • The ending
• Discussion topics
  • pyfingerd structure
    • Interfaces
    • Formatters
  • Fictional interfaces
    • Scenario interface
    • Live interface
  • Scenarios and actions
    • Loading a scenario programatically
    • Scenario files
• Configuration options
  • Binding
  • Setting the hostname
  • Defining the server type
  • Defining the scenario
• API Reference
  • Core API
    • Base representations
    • The base interface class
    • The base formatter class
    • The server object
  • Fictional interfaces API
    • Fictional representations
    • Fictional action representations
    • Playing fictions
    • Playing scenarios
  • Native API