diff --git a/Basic-Usage.md b/Basic-Usage.md new file mode 100644 index 0000000..ba53e2f --- /dev/null +++ b/Basic-Usage.md @@ -0,0 +1,369 @@ +# Basic Usage + +Essential workflows and everyday usage patterns for TTYverse. This guide assumes you've completed [Getting Started](Getting-Started) and have TTYverse configured. + +## Daily Workflow + +### Starting TTYverse +```bash +# Start TTYverse +./ttyverse.pl + +# TTYverse loads and shows: +# - Current version and login status +# - Recent timeline posts +# - Direct messages (if any) +# - Ready prompt: TTYverse> +``` + +### Reading Your Timeline +When TTYverse starts, it automatically loads your home timeline: + +``` +a0> {,POST_ID} (2h ago) via Web [Public] + Content of the post goes here with any links or hashtags + +a1> {,POST_ID} (1h ago) via TTYverse [Unlisted] + Another post with different visibility +``` + +**Understanding the format:** +- **a0**, **a1** - Menu codes for referencing posts +- **username** - Who posted it +- **(2h ago)** - How long ago it was posted +- **via Web** - What client was used +- **[Public]** - Visibility level + +### Loading More Content +```bash +# See more posts from timeline +/again + +# Refresh timeline for new posts +/refresh + +# See posts from cache +/last 15 +``` + +## Reading Different Timelines + +### Home Timeline (Default) +Your personalized feed from accounts you follow: +```bash +/timeline # Show home timeline +``` + +### Local Timeline +Posts from your instance/server: +```bash +/timeline local # See what your community is posting +``` + +### Federated Timeline +Posts from across the fediverse: +```bash +/timeline federated # See the broader conversation +``` + +### Bookmarks +Posts you've saved: +```bash +/timeline bookmarks # Your saved posts +``` + +## Interacting with Posts + +### Basic Interactions +```bash +# Like a post +/fav a3 + +# Share a post (boost/reblog) +/boost a3 + +# Save for later +/bookmark a3 + +# Reply to a post +/reply a3 Great point about accessibility! +``` + +### Opening Links +When posts contain URLs: +```bash +# Open the URL from post a3 +/url a3 + +# TTYverse automatically detects your environment: +# - GUI environment: Opens in Firefox, Chrome, etc. +# - Terminal: Opens in w3m, elinks, or lynx +``` + +### Getting User Information +```bash +# Learn about a user +/whois storm@stormux.org + +# Shows profile information, follower count, etc. +``` + +## Creating Content + +### Simple Text Posts +```bash +# Create a public post +/post Just learned about TTYverse - loving the accessibility focus! + +# TTYverse creates the post and shows confirmation +``` + +### Posts with Media +```bash +# Upload an image +/media ~/pictures/sunset.jpg + +# TTYverse will prompt for: +# 1. Alt-text description (required for images) +# 2. Optional post message +``` + +**Alt-text example:** +``` +Enter alt text for sunset.jpg: Orange and purple clouds over mountains during golden hour +Enter post message (optional): Beautiful evening hike in the local mountains +``` + +### Replying to Conversations +```bash +# Reply to someone's post +/reply a5 That's exactly what I was thinking! Have you tried the new media upload feature? + +# Your reply appears in the conversation thread +``` + +## Managing Conversations + +### Direct Messages +```bash +# Check for direct messages +/dms + +# Shows recent DMs: +[DM da0][friend@instance.org] (1h ago) + Hey, saw your post about TTYverse - is it really that accessible? + +# Reply to a DM +/reply da0 Yes! It's designed by a blind developer with accessibility as the top priority. +``` + +### Following Conversations +```bash +# Follow an interesting user +/follow @username@instance.com + +# Their posts will appear in your home timeline +``` + +## Searching and Discovery + +### Finding Content +```bash +# Search for hashtags +/search #accessibility + +# Find users +/search storm@stormux.org + +# Search post content +/search "command line fediverse" +``` + +### Exploring Communities +```bash +# See what your local instance is discussing +/timeline local + +# Discover broader conversations +/timeline federated + +# Find trending topics (if your server supports it) +/search #trending +``` + +## Voting in Polls + +When you see a poll in your timeline, it appears with numbered options: + +``` +b3> {,POST_ID} (30m ago) via Web [Public] + What's your favorite terminal editor? + + Poll (ends in 2 days, 15 votes): + 1. vim (8 votes - 53%) + 2. emacs (4 votes - 27%) + 3. nano (3 votes - 20%) +``` + +Vote using the menu code and option number: +```bash +# Vote for option 1 (vim) +/vote b3 1 + +# For multiple choice polls, vote for multiple options +/vote b3 1,3 +``` + +## Managing Your Experience + +### Adjusting Settings +```bash +# Change how often timeline refreshes (in seconds) +/set effpause 300 # Refresh every 5 minutes + +# Set your preferred browsers +/set gui_browser firefox +/set cli_browser w3m + +# Check current settings +/get effpause +``` + +### Getting Information +```bash +# See available commands +/help + +# Check API rate limits +/rate + +# See TTYverse version +/version +``` + +### Controlling Output +```bash +# Enable detailed output +/verbose + +# Enable debug information (for troubleshooting) +/debug +``` + +## Sound Notifications + +TTYverse includes audio feedback for different events: + +- **New posts** - Gentle notification sound +- **Mentions** - Distinctive alert when someone mentions you +- **Direct messages** - Special sound for private messages +- **Your posts** - Confirmation when your posts appear +- **Boosts/favorites** - Feedback when others interact with your posts + +Sound files are stored in `~/.local/share/ttyverse/sounds/default/` + +## Common Workflows + +### Morning Routine +```bash +# Start TTYverse and catch up +./ttyverse.pl # Shows recent timeline +/dms # Check direct messages +/timeline local # See community activity +``` + +### Active Participation +```bash +# Engage with interesting content +/fav a3 # Like interesting posts +/boost a5 # Share good content +/reply a7 Great insight! # Join conversations +/post Today I learned... # Share your thoughts +``` + +### Content Creation +```bash +# Share a photo with proper accessibility +/media ~/photo.jpg +# Alt-text: "Golden retriever playing in autumn leaves" +# Message: "Morning walk with the dog - beautiful fall colors!" +``` + +### Research and Discovery +```bash +# Explore topics +/search #photography # Find photography discussions +/timeline federated # See broader conversations +/search @expert # Find knowledgeable users +/follow @expert@domain # Follow interesting people +``` + +### End of Session +```bash +# Save interesting posts for later +/bookmark a3 +/bookmark b7 + +# Exit cleanly +/quit +``` + +## Tips for Effective Usage + +### Navigation Tips +1. **Use menu codes efficiently** - They're faster than scrolling +2. **Bookmark interesting posts** - Save them for later reference +3. **Follow local timeline** - Discover your community +4. **Use search regularly** - Find conversations on topics you care about + +### Engagement Tips +1. **Always provide alt-text** - TTYverse enforces this for good reason +2. **Reply thoughtfully** - Add value to conversations +3. **Use appropriate visibility** - Consider who should see your posts +4. **Boost good content** - Help spread valuable information + +### Accessibility Tips +1. **TTYverse is screen reader friendly** - All output is plain text +2. **Sound notifications help** - Audio cues for different events +3. **Consistent structure** - Posts always follow the same format +4. **Keyboard-only navigation** - No mouse required anywhere + +### Performance Tips +1. **Adjust refresh rate** - Slower connections benefit from longer intervals +2. **Use /last command** - Access cached posts without network requests +3. **Bookmark instead of searching** - Faster access to interesting content + +## Troubleshooting Common Issues + +### Timeline Issues +```bash +# Timeline won't load +/refresh # Force refresh +# Check network: ping 8.8.8.8 + +# Old posts showing +/timeline # Reload home timeline +``` + +### Interaction Problems +```bash +# Menu codes not working +# Make sure you're using current codes (they change as new posts load) + +# Can't reply or boost +# Check if post is still available: /url a3 +``` + +### Media Upload Issues +```bash +# Image upload fails +# Ensure file exists: ls -la ~/path/to/image.jpg +# Check file size (8MB limit for images on most servers) +# Provide meaningful alt-text (required!) +``` + +--- + +**See also:** [Getting Started](Getting-Started) | [Commands Reference](Commands-Reference) | [Media Uploads](Media-Uploads) + +*Last updated: 2025-07-28* \ No newline at end of file diff --git a/Commands-Reference.md b/Commands-Reference.md new file mode 100644 index 0000000..68d6f5c --- /dev/null +++ b/Commands-Reference.md @@ -0,0 +1,287 @@ +# Commands Reference + +Complete reference for all TTYverse commands. Commands are entered at the `TTYverse>` prompt and always start with `/`. + +## Timeline & Navigation Commands + +### `/timeline [type]` +Display timeline content. + +**Usage:** +- `/timeline` - Show home timeline (default) +- `/timeline local` - Show local instance timeline +- `/timeline federated` - Show federated timeline +- `/timeline bookmarks` - Show bookmarked posts + +**Examples:** +```bash +/timeline # Home timeline +/timeline local # Local posts +/timeline federated # All federated posts +/timeline bookmarks # Your bookmarks +``` + +### `/again` +Show more posts from the current timeline. + +### `/refresh` +Refresh the current timeline and fetch new posts. + +### `/last [number]` +Show the last N posts from cache. + +**Example:** +```bash +/last 10 # Show last 10 posts +``` + +## Posting Commands + +### `/post ` +Create a new public post. + +**Usage:** +```bash +/post Hello fediverse! +/post This is a longer post with multiple words +``` + +**Note:** Posts default to public visibility. + +### `/reply ` +Reply to a specific post using its menu code. + +**Usage:** +```bash +/reply a3 Thanks for sharing! +/reply b1 Great point about accessibility +``` + +### `/media [message]` +Upload media (image, audio, video) with optional post text. + +**Usage:** +```bash +/media /path/to/image.jpg # Upload image only +/media /path/to/audio.mp3 Great song! # Upload with message +``` + +**Accessibility:** Images require alt-text descriptions. TTYverse will prompt for alt-text and cancel uploads without descriptions. + +**Supported formats:** +- **Images:** JPEG, PNG, GIF, WebP +- **Audio:** MP3, OGG, WAV, FLAC, M4A +- **Video:** MP4, WebM, MOV + +## Interaction Commands + +### `/boost ` +Boost (reblog) a post. + +**Usage:** +```bash +/boost a3 # Boost post a3 +/boost b7 # Boost post b7 +``` + +### `/unboost ` +Remove boost from a post. + +### `/fav ` / `/favorite ` +Favorite (like) a post. + +**Usage:** +```bash +/fav a3 # Favorite post a3 +/favorite b1 # Same as /fav +``` + +### `/unfav ` +Remove favorite from a post. + +### `/bookmark ` +Bookmark a post for later. + +### `/unbookmark ` +Remove bookmark from a post. + +### `/vote ` +Vote in a poll. + +**Usage:** +```bash +/vote a3 1 # Vote for option 1 +/vote b2 2,3 # Vote for options 2 and 3 (multiple choice) +/vote c1 1-3 # Vote for options 1 through 3 +``` + +## Direct Messages + +### `/dms` +Show recent direct messages. + +### `/reply ` +Reply to a direct message. + +**Usage:** +```bash +/reply da1 Thanks for the message! +``` + +## Search Commands + +### `/search ` +Search for posts, hashtags, or accounts. + +**Usage:** +```bash +/search #accessibility # Search hashtag +/search @username@instance.com # Search user +/search "climate change" # Search text +/search technology # Search term +``` + +### `/whois ` +Get information about a user. + +**Usage:** +```bash +/whois storm@stormux.org +/whois @localuser +``` + +## Account & Profile Commands + +### `/follow ` +Follow a user. + +**Usage:** +```bash +/follow storm@stormux.org +/follow @localuser +``` + +### `/unfollow ` +Unfollow a user. + +### `/block ` +Block a user. + +### `/unblock ` +Unblock a user. + +### `/mute ` +Mute a user. + +### `/unmute ` +Unmute a user. + +## URL & Link Commands + +### `/url ` +Open URL from a post in your browser. + +**Usage:** +```bash +/url a3 # Open URL from post a3 +``` + +TTYverse automatically detects your environment and uses: +- **GUI browsers:** Firefox, Chrome, etc. (if DISPLAY is set) +- **CLI browsers:** w3m, elinks, lynx (in terminal) + +**Configuration:** +- Set `gui_browser` in config for GUI preference +- Set `cli_browser` in config for CLI preference + +## Information Commands + +### `/help` +Show available commands. + +### `/version` +Show TTYverse version information. + +### `/about` +Show information about TTYverse. + +### `/rate` +Show current API rate limit status. + +## Configuration Commands + +### `/set