Skip to content

Latest commit

 

History

History
80 lines (46 loc) · 8.77 KB

user-guide.md

File metadata and controls

80 lines (46 loc) · 8.77 KB

Start with your own files

English · 简体中文 · Documentation

Glim is a file-viewing workspace for Mac. Use it to read a contract, study reference material, or inspect data and code. Open files you already have. Browse topics to find tasks that fit your work.

Open a file or a folder

See installation first.

  • ⌘O opens a file; ⌘⇧O opens a folder as a workspace. Use the sidebar to open related files.
  • Add Folder to Workspace appends material to the current workspace. The sidebar can also hold several workspaces, each retaining its own tabs when switched.
  • Home offers file, workspace and new-file actions, plus recent workspaces. Renaming a workspace changes its display name, not the directory on disk.
  • ⌘K or ⇧⌘F searches the workspace. Text-content search falls back to filenames when it finds no matches or cannot complete. ⌘F finds within the current file; ⌥⌘F opens replacement in editable text.

Move files and folders

In a local file tree, drag one file or folder onto a destination folder. The destination highlights, and pausing over a collapsed folder expands it. Workspace roots can receive items. You can also use Move to Folder… in an item's context menu, or select it in the file tree and press ⇧⌘M to choose a destination.

Moves refuse existing names and moving a folder into itself or its descendants. Save unsaved files first. Open tabs reload at their new paths; undo history and document preview position may reset. SSH workspaces remain read-only.

Open a remote folder

Use the arrow beside Home’s Open Workspace… button to add an SSH connection or choose a saved connection. Settings → Files → SSH Connections manages multiple connections and offers a connection test. Enter a host (an SSH configuration alias also works), optionally a username or port. The form shows name, host and port, username, and private key in that order. Glim uses your Mac’s SSH configuration and agent when optional fields are empty. Connection tests cover the form with a status overlay; success dismisses after two seconds, and errors can be closed to edit the form. Saving from the manager immediately returns to the updated connection list and retains a successful test connection when its host and authentication settings still match. Green globes in the workspace list and recent workspaces, and green dots in SSH dialogs, indicate a live session. Red means disconnected or not connected; saving configuration alone does not establish a connection. The indicators update automatically when the SSH process exits. OpenSSH asks for host trust, passwords or key passphrases when needed.

Choose the connection, enter a directory path or browse folders (including hidden folders), then confirm Open Folder beside the target path. Recent remote workspaces reconnect directly. Files download on demand and stay read-only, including text. A globe identifies remote workspaces; file tabs retain only their file-type icons. Hover over a tab for its host and read-only status. Cancelling the folder browser returns to the connection list (except when adding a folder to the current remote workspace). If a directory request stops receiving data, it times out and releases the loading state. The existing Refresh action refreshes or reconnects; remote changes are not watched automatically. Downloads use temporary local storage and large files must finish downloading before preview. Directory document packages and complete HTML sites are not mirrored. For a consistent SQLite view, open a database copy that is no longer changing.

Keep related files open

Opening a file leaves a tab so you can return after opening another. Reopening the same file activates its existing tab or window. Back and Forward revisit previously opened files.

A tab's context menu can reveal it in Finder, copy its path or move it to a separate window. You can also drag a tab out. Collapse the sidebar for more reading space; the folder icon in the narrow rail expands it again.

⌘W closes the current tab or an empty window. ⌘⇧W closes the current window. Closing the last window leaves Glim running; ⌘Q quits. Unsaved work goes through save confirmation.

Choose how to view the content

Content Common actions
Contracts, reports and presentations Page, select text and zoom in PDFs; switch Word Reading mode / Original layout; show supported documents fullscreen
Spreadsheets and data Switch Excel worksheets and pages; read CSV/TSV tables; expand JSON trees
Notes and technical documents Switch Markdown Preview / Source; read formulas and diagrams; check and save tasks in ordinary task lists
Images and fonts Zoom and copy images; extract text from supported raster previews; enter font samples
Ebooks and comics Contents, chapters or comic pages, typography, bookmarks and saved position
Audio and video Playback and ordered or shuffled folder playlists

PDFs open fitted to the content area's width; images and SVGs fit fully within the viewport. Fit mode follows window and sidebar resizing. Multipage PDFs retain continuous vertical scrolling, and manual zoom allows scrolling through details. The PDF toolbar and ⌘0 restore Fit width; the context menu also offers Fit page. For images, ⌘0 restores Fit image. | Mind maps and structured data | Expand or fold XMind topics; switch supported data to an interactive graph |

Actions appear in toolbars or content context menus. Some floating toolbars appear when you pause the pointer near the bottom of the content. File fullscreen expands the current reader; Escape returns to the workspace. ⌘B shows or hides workspaces; ⌥⌘B toggles the file tree. ⌥⌘P switches Preview / Source, and Control-Tab / Control-Shift-Tab switches file tabs. ⌘/ opens keyboard help, also available in Settings → Keyboard Shortcuts.

Actions differ by format. See topics and format compatibility.

Make a small text edit

Ordinary UTF-8 text supports typing, selection, undo/redo and ⌘S. Existing files save automatically after a short typing pause, directly to the original. Keep this in mind with configuration and shared files. If another application changes the file before saving, Glim keeps your unsaved editor content and reports a conflict.

⌘N creates an untitled note. Its first ⌘S asks for a location and name; later edits save automatically. Changing the extension does not convert text into a PDF or Office document.

Large or long-line text uses editable pages; save pending page edits before navigating when prompted. Tables, trees, databases, images and Office previews are read-only; edit supported text through Source. Closing unsaved content offers Save, Don't Save or Cancel. A failed save leaves it open.

Inspect a database or unpack a handoff

Open the main SQLite file, choose a table or view, filter, sort and page. Double-click a cell for its full value. Glim creates a separate read-only snapshot with available WAL/journal data; it does not modify or checkpoint the source. Encrypted databases and arbitrary write SQL are unsupported.

ZIP, TAR and compressed TAR, 7z, RAR and other supported archives share a directory browser. Open folders to inspect entry names and sizes, then extract into a separate new workspace. Existing directories are not overwritten, and extraction can be cancelled. Standalone GZ/BZ2/XZ/LZ4/Zstandard streams appear as a single decompressed file. Password-protected, multipart and unsupported codec variants report an error.

Continue next time

Normal startup can restore saved windows, workspaces, ordered file tabs and supported preview modes. Open recent workspaces in the current or a new window. Moved or deleted files remain visible as unavailable tabs.

General scroll and cursor positions and media time are not fully restored. Restored media stays paused. Ebooks separately save reading progress and bookmarks.

Untitled notes use local recovery checkpoints. Changes not yet checkpointed can still be lost; save important notes as files. Application updates have a separate one-time restart checkpoint; see updates and recovery. Session records and application backups do not replace backups of your files.

Settings and help

Settings includes appearance, language, default file associations, update checks, shortcuts and usage-statistics controls. Making Glim the default for a file type can cause Finder to open those files in Glim.

See privacy for network and local-storage behavior. For opening, preview or saving problems, check common questions, then report an issue with your version, Mac type, steps and a sanitized sample. Logs may contain local paths; review them before sharing.