Jatin K MalikandGitHub
a28f55b72e
* Add pre-commit hooks to match CI pipeline linting rules * Add pre-commit hooks that match GitHub CI pipeline exactly * Ran lint check
2.9 KiB
2.9 KiB
User Guide
This guide explains how to use Vocalinux effectively.
Getting Started
After installing Vocalinux (see the Installation Guide), you can start the application from the terminal or add it to your startup applications.
Basic Usage
Starting and Stopping Voice Typing
- Launch the application: Run
vocalinuxin a terminal or launch it from your application menu - Find the tray icon: Look for the microphone icon in your system tray
- Start voice typing: Click the tray icon and select "Start Voice Typing" from the menu
- Speak clearly: As you speak, your words will be transcribed into the currently focused application
- Stop voice typing: Click the tray icon and select "Stop Voice Typing" when you're done
Understanding the Status Icons
- Microphone off (gray): Voice typing is inactive
- Microphone on (blue): Voice typing is active and listening
- Microphone processing (orange): Voice typing is processing your speech
Voice Commands
Vocalinux supports several commands that you can speak to control formatting:
| Command | Action |
|---|---|
| "new line" or "new paragraph" | Inserts a line break |
| "period" or "full stop" | Types a period (.) |
| "comma" | Types a comma (,) |
| "question mark" | Types a question mark (?) |
| "exclamation point" or "exclamation mark" | Types an exclamation point (!) |
| "semicolon" | Types a semicolon (;) |
| "colon" | Types a colon (:) |
| "delete that" or "scratch that" | Deletes the last sentence |
| "capitalize" or "uppercase" | Capitalizes the next word |
| "all caps" | Makes the next word ALL CAPS |
Tips for Better Recognition
- Use a good microphone: A quality microphone significantly improves recognition accuracy
- Speak clearly: Enunciate your words clearly but naturally
- Moderate pace: Don't speak too quickly or too slowly
- Quiet environment: Minimize background noise when possible
- Learn commands: Familiarize yourself with voice commands for punctuation and formatting
- Use larger models: For better accuracy, use
vocalinux --model mediumor--model large
Customization
Keyboard Shortcuts
Vocalinux supports global keyboard shortcuts for starting and stopping voice typing:
- Open the application settings from the tray icon menu
- Go to the "Shortcuts" tab
- Set your preferred keyboard shortcut (default is Alt+Shift+V)
Model Settings
You can change the speech recognition model for better accuracy or faster performance:
- Open settings from the tray icon menu
- Go to the "Recognition" tab
- Select your preferred model size
- Choose between VOSK (offline, faster) and Whisper (offline, more accurate)
Troubleshooting
If you encounter issues, check the Installation Guide troubleshooting section or run the application with debug logging:
vocalinux --debug
Check the logs for error messages and possible solutions.